Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix doxygen groups in many places #14157

Merged
merged 2 commits into from
Jul 24, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/doxygen/headers/iterators.h
Original file line number Diff line number Diff line change
Expand Up @@ -383,7 +383,7 @@ levels, and accessors for objects of lower dimensionality do not have a
@ingroup grid
*/

//@}
/** @} */
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To me, this looks not as nice as would

Suggested change
/** @} */
/// @}

As far as I know, doxygen should also pick up /// comments. If others prefer the version here, I am happy to support that as well.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, those work as well.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My motivation was making it symmetric with the opening @{ which can be grouped with @name etc.

drwells marked this conversation as resolved.
Show resolved Hide resolved


/**
Expand Down
4 changes: 2 additions & 2 deletions include/deal.II/algorithms/general_data_storage.h
Original file line number Diff line number Diff line change
Expand Up @@ -177,8 +177,8 @@ class GeneralDataStorage : public Subscriptor

/**
* @name Data storage and access
* @{
*/
//@{

/**
* Store internally a copy of the given object. The copied object is
Expand Down Expand Up @@ -327,7 +327,7 @@ class GeneralDataStorage : public Subscriptor
void
remove_object_with_name(const std::string &name);

//@}
/** @} */

/**
* An entry with this name does not exist in the internal boost::any map.
Expand Down
2 changes: 1 addition & 1 deletion include/deal.II/base/convergence_table.h
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ class ConvergenceTable : public TableHandler
DeclException1(ExcRateColumnAlreadyExists,
std::string,
<< "Rate column <" << arg1 << "> does already exist.");
//@}
/** @} */
};


Expand Down
6 changes: 3 additions & 3 deletions include/deal.II/base/data_out_base.h
Original file line number Diff line number Diff line change
Expand Up @@ -401,7 +401,7 @@ namespace DataOutBase
<< "It is not possible to have a structural dimension of " << arg1
<< " to be larger than the space dimension of the surrounding"
<< " space " << arg2);
//@}
/** @} */
};


Expand Down Expand Up @@ -553,7 +553,7 @@ namespace DataOutBase
<< "It is not possible to have a structural dimension of " << arg1
<< " to be larger than the space dimension of the surrounding"
<< " space " << arg2);
//@}
/** @} */
};


Expand Down Expand Up @@ -2528,7 +2528,7 @@ namespace DataOutBase
<< "There was an error opening Tecplot file " << arg1
<< " for output.");

//@}
/** @} */
} // namespace DataOutBase


Expand Down
4 changes: 2 additions & 2 deletions include/deal.II/base/exceptions.h
Original file line number Diff line number Diff line change
Expand Up @@ -626,8 +626,8 @@ namespace StandardExceptions
{
/**
* @addtogroup Exceptions
* @{
*/
//@{

/**
* Exception denoting a division by zero.
Expand Down Expand Up @@ -1139,7 +1139,7 @@ namespace StandardExceptions
std::string,
<< "There was an error in a cuSPARSE function: " << arg1);
#endif
//@}
/** @} */

/**
* This function requires support for the Exodus II library.
Expand Down
2 changes: 1 addition & 1 deletion include/deal.II/base/function_parser.h
Original file line number Diff line number Diff line change
Expand Up @@ -368,7 +368,7 @@ class FunctionParser
<< ") is not equal to the number of expressions (" << arg2
<< ").");

//@}
/** @} */
};


Expand Down
2 changes: 1 addition & 1 deletion include/deal.II/base/mu_parser_internal.h
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ namespace internal
<< "Parsing Error at Column " << arg1
<< ". The parser said: " << arg2);

//@}
/** @} */

/**
* deal.II uses muParser as a purely internal dependency. To this end, we do
Expand Down
2 changes: 1 addition & 1 deletion include/deal.II/base/parameter_handler.h
Original file line number Diff line number Diff line change
Expand Up @@ -1716,7 +1716,7 @@ class ParameterHandler : public Subscriptor
"file to include <"
<< arg3 << "> cannot be opened.");

//@}
/** @} */

private:
/**
Expand Down
8 changes: 4 additions & 4 deletions include/deal.II/base/patterns.h
Original file line number Diff line number Diff line change
Expand Up @@ -538,7 +538,7 @@ namespace Patterns
int,
<< "The values " << arg1 << " and " << arg2
<< " do not form a valid range.");
//@}
/** @} */
private:
/**
* Copy of the pattern that each element of the list has to satisfy.
Expand Down Expand Up @@ -685,7 +685,7 @@ namespace Patterns
int,
<< "The values " << arg1 << " and " << arg2
<< " do not form a valid range.");
//@}
/** @} */
private:
/**
* Copy of the patterns that each key and each value of the map has to
Expand Down Expand Up @@ -960,7 +960,7 @@ namespace Patterns
int,
<< "A comma was found at position " << arg1
<< " of your input string, but commas are not allowed here.");
//@}
/** @} */
private:
/**
* List of valid strings as passed to the constructor. We don't make this
Expand Down Expand Up @@ -1404,7 +1404,7 @@ namespace Patterns
std::string,
<< "The string \"" << arg1
<< "\" does not match the pattern \"" << arg2 << "\"");
//@}
/** @} */
} // namespace Tools
} // namespace Patterns

Expand Down
9 changes: 5 additions & 4 deletions include/deal.II/base/qprojector.h
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,10 @@
DEAL_II_NAMESPACE_OPEN


/*!@addtogroup Quadrature */
/*@{*/

/**
* @addtogroup Quadrature
* @{
*/

/**
* This class is a helper class to facilitate the usage of quadrature formulae
Expand Down Expand Up @@ -333,7 +334,7 @@ class QProjector
};
};

/*@}*/
/** @} */


// ------------------- inline and template functions ----------------
Expand Down
8 changes: 5 additions & 3 deletions include/deal.II/base/quadrature.h
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,10 @@

DEAL_II_NAMESPACE_OPEN

/*!@addtogroup Quadrature */
/*@{*/
/**
* @addtogroup Quadrature
* @{
*/

/**
* Base class for quadrature formulae in arbitrary dimensions. This class
Expand Down Expand Up @@ -403,7 +405,7 @@ class QIterated : public Quadrature<dim>



/*@}*/
/** @} */

#ifndef DOXYGEN

Expand Down
8 changes: 5 additions & 3 deletions include/deal.II/base/quadrature_lib.h
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,10 @@

DEAL_II_NAMESPACE_OPEN

/*!@addtogroup Quadrature */
/*@{*/
/**
* @addtogroup Quadrature
* @{
*/

/**
* The Gauss-Legendre family of quadrature rules for numerical integration.
Expand Down Expand Up @@ -908,7 +910,7 @@ class QGaussPyramid : public Quadrature<dim>
explicit QGaussPyramid(const unsigned int n_points_1D);
};

/*@}*/
/** @} */

/* -------------- declaration of explicit specializations ------------- */

Expand Down
8 changes: 5 additions & 3 deletions include/deal.II/base/quadrature_point_data.h
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,10 @@

DEAL_II_NAMESPACE_OPEN

/*!@addtogroup Quadrature */
/*@{*/
/**
* @addtogroup Quadrature
* @{
*/

/**
* A class for storing at each cell represented by iterators of type @p CellIteratorType
Expand Down Expand Up @@ -587,7 +589,7 @@ namespace parallel

#endif

/*@}*/
/** @} */

#ifndef DOXYGEN

Expand Down
2 changes: 1 addition & 1 deletion include/deal.II/base/quadrature_selector.h
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ class QuadratureSelector : public Quadrature<dim>
DeclException1(ExcInvalidQuadrature,
std::string,
<< arg1 << " is not a valid name for a quadrature rule.");
//@}
/** @} */
private:
/**
* This static function creates a quadrature object according to the name
Expand Down
6 changes: 3 additions & 3 deletions include/deal.II/base/subscriptor.h
Original file line number Diff line number Diff line change
Expand Up @@ -106,8 +106,8 @@ class Subscriptor
*
* Classes derived from Subscriptor provide a facility to subscribe to this
* object. This is mostly used by the SmartPointer class.
* @{
*/
// @{

/**
* Subscribes a user of the object by storing the pointer @p validity. The
Expand Down Expand Up @@ -148,7 +148,7 @@ class Subscriptor
void
list_subscribers() const;

// @}
/** @} */

/**
* @addtogroup Exceptions
Expand Down Expand Up @@ -181,7 +181,7 @@ class Subscriptor
<< "No subscriber with identifier <" << arg2
<< "> subscribes to this object of class " << arg1
<< ". Consequently, it cannot be unsubscribed.");
//@}
/** @} */

/**
* Read or write the data of this object to or from a stream for the purpose
Expand Down
2 changes: 1 addition & 1 deletion include/deal.II/base/table_handler.h
Original file line number Diff line number Diff line change
Expand Up @@ -620,7 +620,7 @@ class TableHandler
<< '<' << arg1 << "> is not a tex column format. Use "
<< "'l', 'c', or 'r' to indicate left, centered, or "
<< "right aligned text.");
//@}
/** @} */
protected:
/**
* Structure encapsulating all the data that is needed to describe one
Expand Down
24 changes: 10 additions & 14 deletions include/deal.II/base/tensor.h
Original file line number Diff line number Diff line change
Expand Up @@ -1889,8 +1889,8 @@ constexpr unsigned int Tensor<rank_, dim, Number>::n_independent_components;

/**
* @name Output functions for Tensor objects
* @{
*/
//@{

/**
* Output operator for tensors. Print the elements consecutively, with a space
Expand Down Expand Up @@ -1929,12 +1929,11 @@ operator<<(std::ostream &out, const Tensor<0, dim, Number> &p)
}


//@}
/** @} */
/**
* @name Vector space operations on Tensor objects:
* @{
*/
//@{


/**
* Scalar multiplication of a tensor of rank 0 with an object from the left.
Expand Down Expand Up @@ -2270,12 +2269,11 @@ inline constexpr DEAL_II_ALWAYS_INLINE
return tmp;
}

//@}
/** @} */
/**
* @name Contraction operations and the outer product for tensor objects
* @{
*/
//@{


/**
* The dot product (single contraction) for tensors. This function return a
Expand Down Expand Up @@ -2613,12 +2611,11 @@ constexpr inline DEAL_II_ALWAYS_INLINE
}


//@}
/** @} */
/**
* @name Special operations on tensors of rank 1
* @{
*/
//@{


/**
* Return the cross product in 2d. This is just a rotation by 90 degrees
Expand Down Expand Up @@ -2677,12 +2674,11 @@ constexpr inline DEAL_II_ALWAYS_INLINE
}


//@}
/** @} */
/**
* @name Special operations on tensors of rank 2
* @{
*/
//@{


/**
* Compute the determinant of a tensor or rank 2.
Expand Down Expand Up @@ -3048,7 +3044,7 @@ linfty_norm(const Tensor<2, dim, Number> &t)
return max;
}

//@}
/** @} */


#ifndef DOXYGEN
Expand Down
2 changes: 1 addition & 1 deletion include/deal.II/base/tensor_function_parser.h
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ class TensorFunctionParser
<< ") is not equal to the number of expressions (" << arg2
<< ").");

//@}
/** @} */
private:
/**
* Number of components is equal dim<sup>rank</sup>.
Expand Down
6 changes: 4 additions & 2 deletions include/deal.II/base/thread_local_storage.h
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,10 @@

DEAL_II_NAMESPACE_OPEN

/*!@addtogroup threads */
/*@{*/
/**
* @addtogroup threads
* @{
*/

# ifndef DOXYGEN
class LogStream;
Expand Down