Commit 2eaf9fa5 authored by Alvarez, Gonzalo's avatar Alvarez, Gonzalo
Browse files

doc: variable renamed

parent 0a27f23f
...@@ -62,7 +62,7 @@ keywordstyle=\color{blue}\bfseries,frame=shadowbox} ...@@ -62,7 +62,7 @@ keywordstyle=\color{blue}\bfseries,frame=shadowbox}
\end{center} \end{center}
\begin{center} \begin{center}
\textsc{Oak Ridge, 2018} \textsc{Oak Ridge, 2020}
\end{center} \end{center}
\end{titlepage} \end{titlepage}
...@@ -98,7 +98,7 @@ Note that the \texttt{PartName} will be something descriptive ...@@ -98,7 +98,7 @@ Note that the \texttt{PartName} will be something descriptive
of what we are talking about there and must be \emph{unique}. of what we are talking about there and must be \emph{unique}.
Moreover, that part can be included in this document, Moreover, that part can be included in this document,
the \cppFile{tutorial.ptex} file, by using the command the \cppFile{tutorial.ptex} file, by using the command
\texttt{$\backslash$ptexPast\{PartName\}}, where you have to use \texttt{$\backslash$ptexPaste} \texttt{\{PartName\}}, where you have to use
the right name for \texttt{PartName}. the right name for \texttt{PartName}.
This way we import documentation from each .cpp file This way we import documentation from each .cpp file
into this ptex file. into this ptex file.
......
...@@ -9,7 +9,7 @@ ...@@ -9,7 +9,7 @@
You can go ahead an compile this example with You can go ahead an compile this example with
\begin{tiny} \begin{tiny}
\begin{verbatim} \begin{verbatim}
g++ testInputNg.cpp -I ../src/ -I.. -DUSE_BOOST -L ../lib -lpsimaglite -o testInputNg g++ testInputNg.cpp -std=c++11 -Wall -I ../src/ -I.. -DUSE_BOOST -L ../lib -lpsimaglite -o testInputNg
\end{verbatim} \end{verbatim}
\end{tiny} \end{tiny}
Note that you need boost-dev or boost-devel and also you Note that you need boost-dev or boost-devel and also you
...@@ -28,17 +28,15 @@ First, note that we need two includes from PsimagLite. ...@@ -28,17 +28,15 @@ First, note that we need two includes from PsimagLite.
PsimagLite files are usually under src, but in some PsimagLite files are usually under src, but in some
cases subdirectories are used. Here are the includes. cases subdirectories are used. Here are the includes.
\begin{lstlisting} \begin{lstlisting}
PSIDOCCOPY InputNg_Includes PSIDOC_CAPTURE
\end{lstlisting}
*/ */
/* PSIDOC_CODE_START InputNg_Includes nocapture */
#include "InputNg.h" #include "InputNg.h"
#include "InputCheckBase.h" #include "InputCheckBase.h"
/* PSIDOC_CODE_END */
/* PSIDOC InputNg_MyInputCheck /* PSIDOC InputNg_MyInputCheck
There is an option to check the inputs, so that \end{lstlisting}
InputNg has an option to check the inputs, so that
you can define the labels that you expect to find you can define the labels that you expect to find
in your program. This is optional but recommended. in your program. This is optional but recommended.
For this we create a class, say \texttt{MyInputCheck}, For this we create a class, say \texttt{MyInputCheck},
......
...@@ -111,7 +111,7 @@ sub loadLabels ...@@ -111,7 +111,7 @@ sub loadLabels
my $nlines = scalar(@$lines); my $nlines = scalar(@$lines);
my $inCodeBlock = 0; my $inCodeBlock = 0;
my $codeBuffer = ""; my $codeBuffer = "";
my $capture = 1; my $modifyLater = 1;
for (my $i = 0; $i < $nlines; ++$i) { for (my $i = 0; $i < $nlines; ++$i) {
$_ = $lines->[$i]; $_ = $lines->[$i];
...@@ -119,7 +119,7 @@ sub loadLabels ...@@ -119,7 +119,7 @@ sub loadLabels
my $rest = $1; my $rest = $1;
chomp($rest); chomp($rest);
($label, $additional) = procPsidocName($rest); ($label, $additional) = procPsidocName($rest);
$capture = 1; $modifyLater = 1;
my $txt = $labels{"$label"}; my $txt = $labels{"$label"};
if (defined($txt)) { if (defined($txt)) {
...@@ -139,7 +139,7 @@ sub loadLabels ...@@ -139,7 +139,7 @@ sub loadLabels
($label, $additional) = procPsidocName($rest); ($label, $additional) = procPsidocName($rest);
$label =~ s/ //g; $label =~ s/ //g;
$capture = ($additional eq "nocapture") ? 0 : 1; $modifyLater = ($additional eq "nocapture") ? 0 : 1;
my $txt = $labels{"$label"}; my $txt = $labels{"$label"};
if (defined($txt)) { if (defined($txt)) {
...@@ -162,7 +162,7 @@ sub loadLabels ...@@ -162,7 +162,7 @@ sub loadLabels
} }
if (/\*\//) { if (/\*\//) {
if ($label ne "!DISABLED" and $capture) { if ($label ne "!DISABLED" and $modifyLater) {
my $inlabel = $label."::"; my $inlabel = $label."::";
$buffer =~ s/PSIDOCCOPY \$/PSIDOCCOPY ${inlabel}/g; $buffer =~ s/PSIDOCCOPY \$/PSIDOCCOPY ${inlabel}/g;
my @temp = ($buffer); my @temp = ($buffer);
...@@ -188,7 +188,7 @@ sub loadLabels ...@@ -188,7 +188,7 @@ sub loadLabels
$buffer = ""; $buffer = "";
$label = "!DISABLED"; $label = "!DISABLED";
$capture = 1; $modifyLater = 1;
$additional = ""; $additional = "";
} elsif ($inCodeBlock) { } elsif ($inCodeBlock) {
$codeBuffer .= $_."\n"; $codeBuffer .= $_."\n";
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment