Skip to content

Commit e65969a

Browse files
thewtexCode Review
authored andcommitted
Merge "DOC: Correct Coding Style Guide doxygen links"
2 parents 37c9d72 + 4ab01c8 commit e65969a

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -555,14 +555,14 @@ \subsection{Naming Classes}
555555
556556
Conventions adopted in ITK for naming classes include:
557557
\begin{itemize}
558-
\item The ``To'' convention (such as in \doxygen{itk::ImageToImageFilter}) is
558+
\item The ``To'' convention (such as in \doxygen{ImageToImageFilter}) is
559559
generally used for base classes, and when a filter converts from one data type
560560
to another. Derived classes do not continue the ``To'' convention. Classes like
561-
\doxygen{itk::HistogramToTextureFeaturesFilter}, or
562-
\doxygen{itk::ImageToHistogram} do not produce an image as outputs, but change
561+
\doxygen{HistogramToTextureFeaturesFilter}, or
562+
\doxygen{ImageToHistogram} do not produce an image as outputs, but change
563563
the data type or produce a set of features. The expectation of an ITK filter
564564
name is that it maintains the same type (even when changing the dimensionality
565-
as when changing from an \doxygen{itk::Image} to a \doxygen{VectorImage}) unless
565+
as when changing from an \doxygen{Image} to a \doxygen{VectorImage}) unless
566566
it has the ``To'' naming conventions.
567567
\item Adding the \code{Base} appendix to a base class name is generally
568568
discouraged.
@@ -589,14 +589,14 @@ \subsection{Naming Files}
589589
\code{.cxx} or \code{.hxx}, depending on whether they are implementations of
590590
templated classes.
591591
592-
For example, the class \doxygen{itk::Image}
592+
For example, the class \doxygen{Image}
593593
\begin{itemize}
594594
\item is declared in the file \code{itkImage.h} and
595-
\item is defined in the file \code{itkImage.hxx} (because \doxygen{itk::Image}
595+
\item is defined in the file \code{itkImage.hxx} (because \doxygen{Image}
596596
is templated).
597597
\end{itemize}
598598
599-
The class \doxygen{itk::Object}
599+
The class \doxygen{Object}
600600
\begin{itemize}
601601
\item is declared in the file\code{itkObject.h} and
602602
\item is defined in the file \code{itkObject.cxx}.
@@ -3009,7 +3009,7 @@ \section{Using Standard Macros}
30093009
class, mainly type information. Adds the \code{GetNameOfClass()} method to the
30103010
class.
30113011
\item \code{itkDebugMacro(x)}: If debug is set on a subclass of
3012-
\doxygen{itk::Object}, prints debug information to the appropriate output
3012+
\doxygen{Object}, prints debug information to the appropriate output
30133013
stream.
30143014
\item \code{itkStaticConstMacro(name, type, value)}: Creates a
30153015
\code{static const} member of type \code{type} and sets it to the value
@@ -3195,7 +3195,7 @@ \subsection{Errors in Pipelines}
31953195
When the I/O objects are not set, the ITK
31963196
\code{itkAssertInDebugAndIgnoreInReleaseMacro} macro is used: the ITK processing
31973197
framework should handle this situation and throw the appropriate exception (e.g.
3198-
the \doxygen{itk::ProcessObject} class), such macro assertion is preferred over
3198+
the \doxygen{ProcessObject} class), such macro assertion is preferred over
31993199
an exception, e.g.
32003200
32013201
\small
@@ -3413,7 +3413,7 @@ \section{Printing Variables}
34133413
The following additional conventions apply to printing member variables:
34143414
\begin{itemize}
34153415
\item When printing constructs such as matrices, double indentation should be
3416-
used to print its contents using \doxygen{itk::Indent::GetNextIndent()}.
3416+
used to print its contents using \doxygen{Indent::GetNextIndent()}.
34173417
\item Objects that can be \code{null} (such as \doxygen{SmartPointer}) must be
34183418
printed using the \code{itkPrintSelfObjectMacro} macro.
34193419
\item Without harm to the previous convention, constructs such as images can

0 commit comments

Comments
 (0)