[Positioning] Correct some Doxygen comments

Turn REFERENCES_RELATION to YES in Doxyfile.
This commit is contained in:
Matteo Cypriani 2010-06-22 09:19:29 +02:00
parent 1e605ae16d
commit b21b7bd25f
6 changed files with 6 additions and 9 deletions

View File

@ -707,7 +707,7 @@ REFERENCED_BY_RELATION = NO
# then for each documented function all documented entities
# called/used by that function will be listed.
REFERENCES_RELATION = NO
REFERENCES_RELATION = YES
# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from

View File

@ -39,8 +39,8 @@ Building::~Building()
/**
* @param a A pointer to the Area to add. If \em a is NULL, nothing will
* be added. If the Area it points to already exist in #areas, it is
* @param area A pointer to the Area to add. If \em a is NULL, nothing
* will be added. If the Area it points to already exist in #areas, it is
* deleted and nullified, unless it is the same pointer (see the code to
* understand!); hmm, maybe we should handle that with exceptions
*/

View File

@ -19,7 +19,7 @@ using std::tr1::unordered_map ;
* This function reads the next Request in the CSV input file. Blank
* lines and lines containing only spaces are skipped.
*
* #input_file should be opened before proceeding requests; otherwise,
* #file should be opened before proceeding requests; otherwise,
* #current_request is \link Request::clear() cleared\endlink and a
* blank Request is returned. The file must be valid,
* semicolon-separated (\em not comma-separated).

View File

@ -69,7 +69,7 @@ void Measurement::add_ss_list(const std::vector<int> &_ss_list)
/**
* Merge consists of adding the SS values of #source to #ss_list. It is
* Merge consists of adding the SS values of \em source to #ss_list. It is
* possible only if the #ap of the two Measurement are identical.
* @throw cannot_merge if the AP of the two Measurement are different.
*/

View File

@ -51,9 +51,6 @@ bad_direction::bad_direction(const char direction) throw()
}
/**
* @param medium_name The medium that is unknown
*/
null_input_medium::null_input_medium() throw():
posexcept("The input medium is not initialised!") {}

View File

@ -14,7 +14,7 @@ class Point3D ;
* Building name;Room name;X1;Y1;Z1;X2;Y2;Z2
*
* CSV format for waypoints is:
* X;Y;Z;Building name #1[;Building name #2[[;Building name #n]]]
* X;Y;Z;Building name #1[;Building name #2[[;Building name \#n]]]
*/
class TopologyReaderCSV
{