Skip to content

Commit

Permalink
Small doxygen fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
laurentnoe committed May 13, 2022
1 parent 640d09d commit 97c902d
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 11 deletions.
4 changes: 3 additions & 1 deletion src/automaton.hh
Original file line number Diff line number Diff line change
Expand Up @@ -237,12 +237,14 @@ template<typename T> inline istream& operator>>(istream& is, transition<T>& tr)
}

/**
* @class transition\<void\>
* @class transition
* @tparam void
* @brief transition to a given state (on a given letter)
*/
template<> class transition<void> {
public:
/** @brief build a transition object
* @tparam void
* @param state gives the state number reached by this transition
*/
inline transition<void>(int state = 0) : _state(state) {};
Expand Down
1 change: 0 additions & 1 deletion src/main.cc
Original file line number Diff line number Diff line change
Expand Up @@ -2807,7 +2807,6 @@ int outputPareto(list<seedproperties> & l, char * filename) {




/**
* @brief this method is needed when |A| or |B| size has changed
*/
Expand Down
15 changes: 7 additions & 8 deletions src/matrix.hh
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
/**@name Enable/Disable if
* @brief only for definition and selection of good functions
*/
//@{
// @{
/** @brief struct template is enabled for bool = true
*/
template <bool B, typename T = void> struct enable_if_ca { /** type enabled */ typedef T type; };
Expand All @@ -74,14 +74,14 @@ template <bool B, typename T = void> struct disable_if_ca { /** type enabled */
/** @brief struct template is disabled for bool = true
*/
template <typename T> struct disable_if_ca <true, T> {};
//@}
// @}



/** Zero and One are defined as "copies" for "arithmetic" types (but not for "Cost" types that are <min,plus> defined ... ),
* Transition gives the correct weight for a transition for "arithmetic types" (but for "Cost" type, gives the cost of the letter and not the letter)
*/
//@{
// @{
#ifdef HAS_STD_TYPE_TRAITS

/// arithmetic templates (for double probabilities or for integer count)
Expand Down Expand Up @@ -300,7 +300,7 @@ public:
*/
const std::vector< T > & cells_dense() const { return _cells_dense; }

//@{
// @{
/// print row information
template<typename U> friend ostream& operator<< (ostream& os, const row<U>& m);
/** @brief print a row in "maple" format
Expand All @@ -318,7 +318,7 @@ public:

/// load row information
template<typename U> friend istream& operator>> (istream& is, row<U>& m);
//@}
// @}

protected :
/// final state
Expand Down Expand Up @@ -483,8 +483,7 @@ public:
/**@name IO methods
* @brief IO streams to print/store/load matrix
*/

//@{
// @{
/// print matrix information
template<typename U> friend ostream& operator<< (ostream& os, const matrix<U>& m);
/** @brief print a matrix in "maple" format
Expand All @@ -500,7 +499,7 @@ public:

/// load matrix information
template<typename U> friend istream& operator>> (istream& is, matrix<U>& m);
//@}
// @}

protected :
/// vector of rows
Expand Down
2 changes: 1 addition & 1 deletion src/seed.cc
Original file line number Diff line number Diff line change
Expand Up @@ -854,7 +854,7 @@ void seed::setCyclePos(std::vector<int> cycle_pos, int cycle_size) {

/**
* @brief convert a char into a number
* @brief '0' -> 0, '1' -> 1 ... '9' -> 9, 'A' -> 10 ... 'Z' -> 35, 'a' -> 36 ...
* '0' -> 0, '1' -> 1 ... '9' -> 9, 'A' -> 10 ... 'Z' -> 35, 'a' -> 36 ...
* @param s is the string where conversion is currently processed
* @param pos is the first char inside s where the conversion has to be done
* @return the converted value (integer that represents a seed letter) and increments i to the next symbol
Expand Down

0 comments on commit 97c902d

Please sign in to comment.