Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
DOC: Improve Doxygen Javadoc style examples
- Loading branch information
1 parent
defd9fe
commit 241527a
Showing
3 changed files
with
43 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
/** | ||
* Template to represent limbo numbers. | ||
* | ||
* Specializations for integer types that are part of nowhere. | ||
* It doesn't support with any real types. | ||
* | ||
* @param Tp Type of the integer. Required to be an integer type. | ||
* @param N Number of elements. | ||
*/ | ||
template<typename Tp, std::size_t N> | ||
class DoxyLimbo { | ||
public: | ||
/// Default constructor. Initialize nothing. | ||
DoxyLimbo(); | ||
/// Set Default behavior for copy the limbo. | ||
DoxyLimbo(const DoxyLimbo<Tp, N> &l); | ||
/// Returns the raw data for the limbo. | ||
const Tp *data(); | ||
protected: | ||
Tp p_data[N]; ///< Example for inline comment. | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
/** | ||
* This a simple brief. | ||
* | ||
* And the details goes here. | ||
* Multi lines are welcome. | ||
* | ||
* @param num leave a comment for parameter num. | ||
* @param str leave a comment for the second parameter. | ||
* @return leave a comment for the returned value. | ||
*/ | ||
int doxy_javadoc_example(int num, const char *str); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters