Commit 9c7cfcb6 authored by Chris Cantwell's avatar Chris Cantwell

Merge branch 'fix/docs' into 'master'

Fix documentation issues.

This MR just fixes a few minor errors in the doxygen docs and adds an extra pdflatex run to the user guide to ensure references are properly included.

See merge request !749
parents bf40c447 c3482b04
......@@ -37,7 +37,9 @@ ADD_CUSTOM_TARGET(developer-guide-pdf
${PDFLATEX} --output-directory ${DEVGUIDE} ${DEVGUIDESRC}/developer-guide.tex
COMMAND TEXMFOUTPUT=${DEVGUIDE} ${BIBTEX} ${DEVGUIDE}/developer-guide.aux
COMMAND TEXMFOUTPUT=${DEVGUIDE} ${MAKEINDEX} ${DEVGUIDE}/developer-guide.idx
COMMAND export TEXINPUTS=${CMAKE_SOURCE_DIR}//: &&
COMMAND TEXINPUTS=${CMAKE_SOURCE_DIR}//:
${PDFLATEX} --output-directory ${DEVGUIDE} ${DEVGUIDESRC}/developer-guide.tex
COMMAND TEXINPUTS=${CMAKE_SOURCE_DIR}//:
${PDFLATEX} --output-directory ${DEVGUIDE} ${DEVGUIDESRC}/developer-guide.tex
WORKING_DIRECTORY ${DEVGUIDESRC}
)
......@@ -44,7 +44,9 @@ ADD_CUSTOM_TARGET(user-guide-pdf
${PDFLATEX} --output-directory ${USERGUIDE} ${USERGUIDESRC}/user-guide.tex
COMMAND TEXMFOUTPUT=${USERGUIDE} ${BIBTEX} ${USERGUIDE}/user-guide.aux
COMMAND TEXMFOUTPUT=${USERGUIDE} ${MAKEINDEX} ${USERGUIDE}/user-guide.idx
COMMAND export TEXINPUTS=${CMAKE_SOURCE_DIR}//: &&
COMMAND TEXINPUTS=${CMAKE_SOURCE_DIR}//:
${PDFLATEX} --output-directory ${USERGUIDE} ${USERGUIDESRC}/user-guide.tex
COMMAND TEXINPUTS=${CMAKE_SOURCE_DIR}//:
${PDFLATEX} --output-directory ${USERGUIDE} ${USERGUIDESRC}/user-guide.tex
WORKING_DIRECTORY ${USERGUIDESRC}
)
......@@ -475,11 +475,11 @@ namespace Nektar
/**
* This operation is evaluated as:
* \f{tabbing}
* \hspace{1cm} \= Do \= $e=$ $1, N_{\mathrm{el}}$ \ \
* \> \> Do \= $i=$ $0,N_m^e-1$ \ \
* \hspace{1cm} \= Do \= $e=$ $1, N_{\mathrm{el}}$ \\
* \> \> Do \= $i=$ $0,N_m^e-1$ \\
* \> \> \> $\boldsymbol{\hat{u}}^{e}[i] = \mbox{sign}[e][i] \cdot
* \boldsymbol{\hat{u}}_g[\mbox{map}[e][i]]$ \ \
* \> \> continue \ \
* \boldsymbol{\hat{u}}_g[\mbox{map}[e][i]]$ \\
* \> \> continue \\
* \> continue
* \f}
* where \a map\f$[e][i]\f$ is the mapping array and \a
......
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