Skip to content

Commit d3bc8af

Browse files
minor doxygen fixes
1 parent 84fbcd3 commit d3bc8af

File tree

7 files changed

+9
-39
lines changed

7 files changed

+9
-39
lines changed

src/Doxyfile.in

Lines changed: 0 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1830,18 +1830,6 @@ GENERATE_XML = YES
18301830

18311831
XML_OUTPUT = xml
18321832

1833-
# The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
1834-
# validating XML parser to check the syntax of the XML files.
1835-
# This tag requires that the tag GENERATE_XML is set to YES.
1836-
1837-
XML_SCHEMA =
1838-
1839-
# The XML_DTD tag can be used to specify a XML DTD, which can be used by a
1840-
# validating XML parser to check the syntax of the XML files.
1841-
# This tag requires that the tag GENERATE_XML is set to YES.
1842-
1843-
XML_DTD =
1844-
18451833
# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
18461834
# listings (including syntax highlighting and cross-referencing information) to
18471835
# the XML output. Note that enabling this will significantly increase the size
@@ -2120,30 +2108,13 @@ HAVE_DOT = @HAVE_DOT@
21202108

21212109
DOT_NUM_THREADS = 0
21222110

2123-
# When you want a differently looking font n the dot files that doxygen
2124-
# generates you can specify the font name using DOT_FONTNAME. You need to make
2125-
# sure dot is able to find the font, which can be done by putting it in a
2126-
# standard location or by setting the DOTFONTPATH environment variable or by
2127-
# setting DOT_FONTPATH to the directory containing the font.
2128-
# The default value is: Helvetica.
2129-
# This tag requires that the tag HAVE_DOT is set to YES.
2130-
2131-
DOT_FONTNAME = FreeSans
2132-
21332111
# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
21342112
# dot graphs.
21352113
# Minimum value: 4, maximum value: 24, default value: 10.
21362114
# This tag requires that the tag HAVE_DOT is set to YES.
21372115

21382116
DOT_FONTSIZE = 10
21392117

2140-
# By default doxygen will tell dot to use the default font as specified with
2141-
# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2142-
# the path where dot can find it using this tag.
2143-
# This tag requires that the tag HAVE_DOT is set to YES.
2144-
2145-
DOT_FONTPATH =
2146-
21472118
# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
21482119
# each documented class showing the direct and indirect inheritance relations.
21492120
# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.

src/include/stir/Array.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ class Array : public NumericVectorWithOffset<Array<num_dimensions-1, elemT>, ele
239239
at(const BasicCoordinate<num_dimensions,int> &c) const;
240240
//@}
241241

242-
//! \deprecated a*x+b*y (\see xapyb)
242+
//! \deprecated a*x+b*y (use xapyb)
243243
template <typename elemT2>
244244
STIR_DEPRECATED inline void axpby(const elemT2 a, const Array& x,
245245
const elemT2 b, const Array& y);

src/include/stir/KeyParser.h

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -311,9 +311,7 @@ class KeyParser
311311
//! Returns a string with keywords and their values
312312
/*! Keywords are listed in the order they are inserted in the keymap
313313
(except for start and stop keys which are listed first and last).
314-
315-
\bug breaks with 'vectorised' keys.
316-
*/
314+
*/
317315
virtual std::string parameter_info() const;
318316

319317
// KT 07/02/2001 new

src/include/stir/NumericVectorWithOffset.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ class NumericVectorWithOffset : public VectorWithOffset<T>
120120
//! dividing the elements of the current vector by an \c elemT
121121
inline NumericVectorWithOffset & operator/= (const elemT &v);
122122

123-
//! \deprecated a*x+b*y (\see xapyb)
123+
//! \deprecated a*x+b*y (use xapyb)
124124
template <typename elemT2>
125125
STIR_DEPRECATED inline void axpby(const elemT2 a, const NumericVectorWithOffset& x,
126126
const elemT2 b, const NumericVectorWithOffset& y);

src/include/stir/ProjData.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -306,7 +306,7 @@ class ProjData : public ExamData
306306
//! writes data to a file in Interfile format
307307
Succeeded write_to_file(const std::string& filename) const;
308308

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

src/include/stir/ProjDataInMemory.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ class ProjDataInMemory : public ProjDataFromStream
9191

9292
void set_bin_value(const Bin &bin);
9393

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

src/include/stir/doxygengroups.h

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -296,9 +296,10 @@ estimation. Currently only available for the mMR scanner, and requires CUDA.
296296
*/
297297
/*!
298298
\defgroup Parallelproj Wrapped Parallelproj functionality in STIR
299-
\ingroup projectors
300-
Classes and functions that are used to provide an interface to Parallelproj
301-
functionality. This includes a forward and back projector, and requires CUDA.
299+
\ingroup recon_buildblock
300+
Classes and functions that are used to provide an interface to parallelproj
301+
(https://github.com/gschramm/parallelproj)
302+
functionality. This includes a forward and back projector, and uses either OpenMP or CUDA.
302303
*/
303304

304305
/*!

0 commit comments

Comments
 (0)