Skip to content

Commit

Permalink
minor doxygen fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
KrisThielemans committed Jan 14, 2023
1 parent 84fbcd3 commit d3bc8af
Show file tree
Hide file tree
Showing 7 changed files with 9 additions and 39 deletions.
29 changes: 0 additions & 29 deletions src/Doxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -1830,18 +1830,6 @@ GENERATE_XML = YES

XML_OUTPUT = xml

# The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
# validating XML parser to check the syntax of the XML files.
# This tag requires that the tag GENERATE_XML is set to YES.

XML_SCHEMA =

# The XML_DTD tag can be used to specify a XML DTD, which can be used by a
# validating XML parser to check the syntax of the XML files.
# This tag requires that the tag GENERATE_XML is set to YES.

XML_DTD =

# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
# listings (including syntax highlighting and cross-referencing information) to
# the XML output. Note that enabling this will significantly increase the size
Expand Down Expand Up @@ -2120,30 +2108,13 @@ HAVE_DOT = @HAVE_DOT@

DOT_NUM_THREADS = 0

# When you want a differently looking font n the dot files that doxygen
# generates you can specify the font name using DOT_FONTNAME. You need to make
# sure dot is able to find the font, which can be done by putting it in a
# standard location or by setting the DOTFONTPATH environment variable or by
# setting DOT_FONTPATH to the directory containing the font.
# The default value is: Helvetica.
# This tag requires that the tag HAVE_DOT is set to YES.

DOT_FONTNAME = FreeSans

# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
# dot graphs.
# Minimum value: 4, maximum value: 24, default value: 10.
# This tag requires that the tag HAVE_DOT is set to YES.

DOT_FONTSIZE = 10

# By default doxygen will tell dot to use the default font as specified with
# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
# the path where dot can find it using this tag.
# This tag requires that the tag HAVE_DOT is set to YES.

DOT_FONTPATH =

# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
# each documented class showing the direct and indirect inheritance relations.
# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
Expand Down
2 changes: 1 addition & 1 deletion src/include/stir/Array.h
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ class Array : public NumericVectorWithOffset<Array<num_dimensions-1, elemT>, ele
at(const BasicCoordinate<num_dimensions,int> &c) const;
//@}

//! \deprecated a*x+b*y (\see xapyb)
//! \deprecated a*x+b*y (use xapyb)
template <typename elemT2>
STIR_DEPRECATED inline void axpby(const elemT2 a, const Array& x,
const elemT2 b, const Array& y);
Expand Down
4 changes: 1 addition & 3 deletions src/include/stir/KeyParser.h
Original file line number Diff line number Diff line change
Expand Up @@ -311,9 +311,7 @@ class KeyParser
//! Returns a string with keywords and their values
/*! Keywords are listed in the order they are inserted in the keymap
(except for start and stop keys which are listed first and last).
\bug breaks with 'vectorised' keys.
*/
*/
virtual std::string parameter_info() const;

// KT 07/02/2001 new
Expand Down
2 changes: 1 addition & 1 deletion src/include/stir/NumericVectorWithOffset.h
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ class NumericVectorWithOffset : public VectorWithOffset<T>
//! dividing the elements of the current vector by an \c elemT
inline NumericVectorWithOffset & operator/= (const elemT &v);

//! \deprecated a*x+b*y (\see xapyb)
//! \deprecated a*x+b*y (use xapyb)
template <typename elemT2>
STIR_DEPRECATED inline void axpby(const elemT2 a, const NumericVectorWithOffset& x,
const elemT2 b, const NumericVectorWithOffset& y);
Expand Down
2 changes: 1 addition & 1 deletion src/include/stir/ProjData.h
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,7 @@ class ProjData : public ExamData
//! writes data to a file in Interfile format
Succeeded write_to_file(const std::string& filename) const;

//! \deprecated a*x+b*y (\see xapyb)
//! \deprecated a*x+b*y (use xapyb)
STIR_DEPRECATED virtual void axpby(const float a, const ProjData& x,
const float b, const ProjData& y);

Expand Down
2 changes: 1 addition & 1 deletion src/include/stir/ProjDataInMemory.h
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ class ProjDataInMemory : public ProjDataFromStream

void set_bin_value(const Bin &bin);

//! \deprecated a*x+b*y (\see xapyb)
//! \deprecated a*x+b*y (use xapyb)
STIR_DEPRECATED virtual void axpby(const float a, const ProjData& x,
const float b, const ProjData& y);

Expand Down
7 changes: 4 additions & 3 deletions src/include/stir/doxygengroups.h
Original file line number Diff line number Diff line change
Expand Up @@ -296,9 +296,10 @@ estimation. Currently only available for the mMR scanner, and requires CUDA.
*/
/*!
\defgroup Parallelproj Wrapped Parallelproj functionality in STIR
\ingroup projectors
Classes and functions that are used to provide an interface to Parallelproj
functionality. This includes a forward and back projector, and requires CUDA.
\ingroup recon_buildblock
Classes and functions that are used to provide an interface to parallelproj
(https://github.com/gschramm/parallelproj)
functionality. This includes a forward and back projector, and uses either OpenMP or CUDA.
*/

/*!
Expand Down

0 comments on commit d3bc8af

Please sign in to comment.