Commit 02595eda authored by Jakub Klinkovský's avatar Jakub Klinkovský
Browse files

Disabled AUTOLINK_SUPPORT and added explicit \refs into the documentation comments

Explicit is better than implicit: https://www.python.org/dev/peps/pep-0020/

[ci skip]
parent 6508ef1f
Loading
Loading
Loading
Loading
+1 −1
Original line number Diff line number Diff line
@@ -318,7 +318,7 @@ TOC_INCLUDE_HEADINGS = 0
# globally by setting AUTOLINK_SUPPORT to NO.
# The default value is: YES.

AUTOLINK_SUPPORT       = YES
AUTOLINK_SUPPORT       = NO

# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
# to include (a tag file for) the STL sources as input, then you should set this
+4 −4
Original line number Diff line number Diff line
@@ -35,7 +35,7 @@ class Vector
   typedef Vector< Real, TNL::Devices::Host, Index > HostType;
   typedef Vector< Real, TNL::Devices::Cuda, Index > CudaType;

   /** Constructors and assignment operators are inherited from the class Array. */
   /** Constructors and assignment operators are inherited from the class \ref Array. */
   using Array< Real, Device, Index >::Array;
   using Array< Real, Device, Index >::operator=;

@@ -180,7 +180,7 @@ class Vector
   /**
    * \brief Returns difference between L^p norms of this vector and vector \e v.
    *
    * See also lpNorm(const Real_ p).
    * See also \ref lpNorm.
    *
    * \param v Reference to another vector.
    * \param p Number specifying the dimension of vector space.
@@ -246,7 +246,7 @@ class Vector
   /**
    * \brief Returns specific sums of elements of this vector.
    *
    * Does the same as computePrefixSum(), but computes only sums for elements
    * Does the same as \ref computePrefixSum, but computes only sums for elements
    * with the index in range from \e begin to \e end. The other elements of this
    * vector remain untouched - with the same value. Therefore this method returns
    * a new vector with the length of this vector.
@@ -268,7 +268,7 @@ class Vector
   /**
    * \brief Returns specific sums of elements of this vector.
    *
    * Does the same as computeExclusivePrefixSum(), but computes only sums for elements
    * Does the same as \ref computeExclusivePrefixSum, but computes only sums for elements
    * with the index in range from \e begin to \e end. The other elements of this
    * vector remain untouched - with the same value. Therefore this method returns
    * a new vector with the length of this vector.
+5 −5
Original line number Diff line number Diff line
@@ -20,6 +20,7 @@

namespace TNL {

/// \brief Supported modes for opening \ref TNL::File "files".
enum class IOMode
{
//   undefined = 0,
@@ -57,7 +58,6 @@ public:
   /// Opens file with given \e fileName and returns true/false based on the success in opening the file.
   /// \param fileName String which indicates name of the file user wants to open.
   /// \param mode Indicates what user needs to do with opened file.
   /// Modes to choose: IOMode::read, IOMode::write or IOMode::undefined.
   bool open( const String& fileName,
              const IOMode mode );

@@ -75,10 +75,10 @@ public:
   ///
   /// Returns \e true when the elements are successfully read from given file. Otherwise returns \e false.
   ///
   /// Throws \e std::ios_base::failure on failure.
   /// Throws \ref std::ios_base::failure on failure.
   ///
   /// \tparam Type Type of data.
   /// \tparam Device Place where data are stored after reading from file. For example Devices::Host or Devices::Cuda.
   /// \tparam Device Place where data are stored after reading from file. For example \ref Devices::Host or \ref Devices::Cuda.
   /// \tparam Index Type of index by which the elements are indexed.
   /// \param buffer Pointer in memory where the elements are loaded and stored after reading.
   /// \param elements Number of elements the user wants to get (read) from given file.
@@ -93,10 +93,10 @@ public:
   ///
   /// Returns \e true when the elements are successfully written into given file. Otherwise returns \e false.
   ///
   /// Throws \e std::ios_base::failure on failure.
   /// Throws \ref std::ios_base::failure on failure.
   ///
   /// \tparam Type Type of data.
   /// \tparam Device Place from where the data are loaded before writing into file. For example Devices::Host or Devices::Cuda.
   /// \tparam Device Place from where the data are loaded before writing into file. For example \ref Devices::Host or \ref Devices::Cuda.
   /// \tparam Index Type of index by which the elements are indexed.
   /// \param buffer Pointer in memory where the elements are loaded from before writing into file.
   /// \param elements Number of elements the user wants to write into the given file.
+2 −2
Original line number Diff line number Diff line
@@ -18,7 +18,7 @@ String getFileExtension( const String fileName );

void removeFileExtension( String& file_name );

/// \brief Class for creating the full name of a file.
/// \brief Class for the construction of file names from multiple parts.
///
/// Merges base name, index number and extention to create the full name of a file.
class FileName
@@ -52,7 +52,7 @@ class FileName
      ///
      /// Sets \e index after the base name of given file.
      /// @param index Integer - number of maximum 5(default) digits.
      /// (Number of digits can be changed with \c setDigitsCount).
      /// (Number of digits can be changed with \ref setDigitsCount).
      void setIndex( const int index );

      /// \brief Sets number of digits for index of given file.
+7 −6
Original line number Diff line number Diff line
@@ -22,7 +22,7 @@
namespace TNL {

/**
 * \brief This is the basic class for all 'large' objects like matrices, meshes, grids, solvers, etc..
 * \brief Basic class for all 'large' objects like matrices, meshes, grids, solvers, etc..
 *
 *  Objects like numerical grids, meshes, matrices large vectors etc.
 *  are inherited by this class. This class provides name for such objects. Giving
@@ -30,8 +30,9 @@ namespace TNL {
 *  possible errors in the code. This can help to identify an object where, for
 *  example, one tries to touch non-existing element. All objects of the TNL should
 *  have only constructor with name and then only setter methods and method init.
 *  Each object derived from the Object must be able to tell its type via the method getType and
 *  it must support methods for saving and loading the object from a file.
 *  Each object derived from the Object must be able to tell its type via the method
 *  \ref getType and it must support methods \ref save and \ref load for saving and
 *  loading the object from a \ref File "file".
 */
class Object
{
@@ -41,7 +42,7 @@ class Object
       * \brief Type getter.
       *
       * Returns the type in C++ style - for example the returned value
       * may look as follows: "Vector< double, Devices::Cuda >".
       * may look as \c "Vector< double, Devices::Cuda >".
       */
      static String getType();      

@@ -50,8 +51,8 @@ class Object
      /**
       * \brief This is used for load and save methods.
       *
       * Each object is saved as if it was stored on Devices::Host. So even Vector< double, Devices::Cuda >
       * is saved as Vector< double, Devices::Host >.
       * Each object is saved as if it was stored on \ref Devices::Host. So even
       * \c Vector< double, Devices::Cuda > is saved as \c Vector< double, Devices::Host >.
       */
      static String getSerializationType();

Loading