Commit 4548aa59 authored by David Moxey's avatar David Moxey

Add option for fixed-width stylesheet and remove a few noisy Doxygen warnings

parent 27624434
# Doxygen support
# adapted from http://www.bluequartz.net/projects/EIM_Segmentation/ SoftwareDocumentation/html/usewithcmakeproject.html
# adapted from http://www.bluequartz.net/projects/EIM_Segmentation/
# SoftwareDocumentation/html/usewithcmakeproject.html
OPTION(NEKTAR_BUILD_DOC "Build source code documentation using doxygen" OFF)
CMAKE_DEPENDENT_OPTION(NEKTAR_BUILD_DOC_QHP
......@@ -11,6 +12,9 @@ CMAKE_DEPENDENT_OPTION(NEKTAR_BUILD_DOC_XCODE
CMAKE_DEPENDENT_OPTION(NEKTAR_BUILD_DOC_ECLIPSE
"Use Doxygen to create documentation for Eclipse" OFF
"NEKTAR_BUILD_DOC" OFF)
CMAKE_DEPENDENT_OPTION(NEKTAR_BUILD_DOC_FIXEDWIDTH
"Use a fixed-width style sheet for doxygen output" OFF
"NEKTAR_BUILD_DOC" OFF)
IF (NEKTAR_BUILD_DOC)
FIND_PACKAGE(Doxygen)
......@@ -28,6 +32,11 @@ IF (NEKTAR_BUILD_DOC)
SET(DOXYGEN_GENERATE_ECLIPSEHELP "YES")
ENDIF()
SET(DOXYGEN_EXTRA_CSS "")
IF(NEKTAR_BUILD_DOC_FIXEDWIDTH)
SET(DOXYGEN_EXTRA_CSS "docs/doxygen/doxygen-fixed-width.css")
ENDIF()
INSTALL(DIRECTORY ${PROJECT_BINARY_DIR}/docs/doxygen/html/
DESTINATION ${NEKTAR_DOC_DIR}/doxygen)
......@@ -35,6 +44,9 @@ IF (NEKTAR_BUILD_DOC)
${PROJECT_BINARY_DIR}/docs/doxygen/Doxyfile @ONLY IMMEDIATE)
ADD_CUSTOM_TARGET(doc
COMMAND ${CMAKE_COMMAND} -E copy
${CMAKE_SOURCE_DIR}/docs/doxygen/doxygen-fixed-width.css
${PROJECT_BINARY_DIR}/docs/doxygen/doxygen-fixed-width.css
COMMAND ${DOXYGEN_EXECUTABLE} ${PROJECT_BINARY_DIR}/docs/doxygen/Doxyfile
SOURCES ${PROJECT_BINARY_DIR}/docs/doxygen/Doxyfile)
......
......@@ -1120,7 +1120,7 @@ HTML_STYLESHEET =
# see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_EXTRA_STYLESHEET =
HTML_EXTRA_STYLESHEET = @DOXYGEN_EXTRA_CSS@
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the HTML output directory. Note
......@@ -2157,7 +2157,7 @@ CLASS_GRAPH = YES
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
COLLABORATION_GRAPH = YES
COLLABORATION_GRAPH = NO
# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
# groups, showing the direct groups dependencies.
......
///////////////////////////////////////////////////////////////////////////////
tot///////////////////////////////////////////////////////////////////////////////
//
// File: SparseDiagBlkMatrix.hpp
//
......@@ -43,7 +43,7 @@
#include <fstream>
#include <LibUtilities/LinearAlgebra/SparseMatrixFwd.hpp>
#include <LibUtilities/BasicUtils/SharedArray.hpp> ///< \todo: forward declare
#include <LibUtilities/BasicUtils/SharedArray.hpp>
#include <boost/call_traits.hpp>
......
......@@ -43,7 +43,7 @@
#include <fstream>
#include <LibUtilities/LinearAlgebra/SparseMatrixFwd.hpp>
#include <LibUtilities/BasicUtils/SharedArray.hpp> ///< \todo: forward declare
#include <LibUtilities/BasicUtils/SharedArray.hpp>
#include <boost/call_traits.hpp>
......
......@@ -42,7 +42,7 @@
#include <memory>
#include <LibUtilities/BasicConst/NektarUnivTypeDefs.hpp>
#include <LibUtilities/BasicUtils/SharedArray.hpp> ///< \todo: forward declare
#include <LibUtilities/BasicUtils/SharedArray.hpp>
namespace Nektar
......
......@@ -212,7 +212,7 @@ namespace Nektar
const NekDouble> &inarray);
/// This function calculates the inner product of a function
/// \f$f(\boldsymbol{x})\f$ with respect to all \emph{local}
/// \f$f(\boldsymbol{x})\f$ with respect to all \em local
/// expansion modes \f$\phi_n^e(\boldsymbol{x})\f$.
inline void IProductWRTBase_IterPerExp(
const Array<OneD, const NekDouble> &inarray,
......@@ -226,7 +226,7 @@ namespace Nektar
/// This function calculates the inner product of a function
/// \f$f(\boldsymbol{x})\f$ with respect to the derivative (in
/// direction \param dir) of all \emph{local} expansion modes
/// direction \param dir) of all \em local expansion modes
/// \f$\phi_n^e(\boldsymbol{x})\f$.
MULTI_REGIONS_EXPORT void IProductWRTDerivBase(
const int dir,
......@@ -240,7 +240,7 @@ namespace Nektar
/// This function calculates the inner product of a function
/// \f$f(\boldsymbol{x})\f$ with respect to the derivative (in
/// direction \param dir) of all \emph{local} expansion modes
/// direction \param dir) of all \em local expansion modes
/// \f$\phi_n^e(\boldsymbol{x})\f$.
MULTI_REGIONS_EXPORT void IProductWRTDerivBase
(const Array<OneD, const Array<OneD, NekDouble> > &inarray,
......
......@@ -43,18 +43,17 @@
#include <LibUtilities/Interpreter/Interpreter.h>
#include <LibUtilities/Memory/NekMemoryManager.hpp>
/**
* @brief class for meshing individual curves (1d meshing)
*/
namespace Nektar
{
namespace NekMeshUtils
{
//forward
class CurveMesh;
typedef std::shared_ptr<CurveMesh> CurveMeshSharedPtr;
/**
* @brief class for meshing individual curves (1d meshing)
*/
class CurveMesh
{
public:
......
......@@ -49,9 +49,10 @@ namespace Nektar
namespace SolverUtils
{
/// Defines a callback function which evaluates the flux vector \f$ F(u)
/// \f$ in a conservative advection of the form \f$ \nabla\cdot F(u)
/// \f$.
/**
* Defines a callback function type which evaluates the flux vector \f$ F(u) \f$
* in a conservative advection of the form \f$ \nabla\cdot F(u) \f$.
*/
typedef std::function<void (
const Array<OneD, Array<OneD, NekDouble> >&,
Array<OneD, Array<OneD, Array<OneD, NekDouble> > >&)>
......
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