[Positioning] Fix some Doxygen comments
This commit is contained in:
parent
3d46d64a19
commit
cce949f32a
|
@ -24,7 +24,7 @@ CSVFileReader::~CSVFileReader()
|
||||||
/**
|
/**
|
||||||
* Note that this function is not called by the constructor, so you
|
* Note that this function is not called by the constructor, so you
|
||||||
* must manually call it prior to use read_field().
|
* must manually call it prior to use read_field().
|
||||||
* @return false in case of error (EOF, etc.).
|
* @return \em false in case of error (EOF, etc.), \em true else.
|
||||||
*/
|
*/
|
||||||
bool CSVFileReader::next_line()
|
bool CSVFileReader::next_line()
|
||||||
{
|
{
|
||||||
|
|
|
@ -47,8 +47,8 @@ public:
|
||||||
* Reads a Request, increments current_line_nb, updates #current_request
|
* Reads a Request, increments current_line_nb, updates #current_request
|
||||||
* and returns it.
|
* and returns it.
|
||||||
* @return The Request read, or an empty Request in case of error or
|
* @return The Request read, or an empty Request in case of error or
|
||||||
* EOF (note that when casted in bool, an empty Request is false, see
|
* EOF (note that when casted in bool, an empty Request is \em false,
|
||||||
* Request::operator bool()).
|
* see Request::operator bool()).
|
||||||
*/
|
*/
|
||||||
virtual const Request& get_next_request(void) = 0 ;
|
virtual const Request& get_next_request(void) = 0 ;
|
||||||
|
|
||||||
|
|
|
@ -35,8 +35,8 @@ InputUDPSocket::~InputUDPSocket()
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return true if the socket were successfully opened, false in case of
|
* @return \em true if the socket were successfully opened.
|
||||||
* error.
|
* @return \em false in case of error.
|
||||||
*/
|
*/
|
||||||
bool InputUDPSocket::init_socket()
|
bool InputUDPSocket::init_socket()
|
||||||
{
|
{
|
||||||
|
|
|
@ -36,8 +36,8 @@ OutputUDPSocket::~OutputUDPSocket()
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return true if the socket were successfully opened, false in case of
|
* @return \em true if the socket were successfully opened.
|
||||||
* error.
|
* @return \em false in case of error.
|
||||||
*/
|
*/
|
||||||
bool OutputUDPSocket::init_socket()
|
bool OutputUDPSocket::init_socket()
|
||||||
{
|
{
|
||||||
|
|
|
@ -52,11 +52,11 @@ public:
|
||||||
|
|
||||||
/** @name Operations */
|
/** @name Operations */
|
||||||
//@{
|
//@{
|
||||||
/// Compute the distance between the ReferencePoint and a Request
|
/// Computes the distance between the ReferencePoint and a Request
|
||||||
float ss_square_distance(const Request &source) const ;
|
float ss_square_distance(const Request &source) const ;
|
||||||
/// Compute the Friis index for the given AccessPoint
|
/// Computes the Friis index for the given AccessPoint
|
||||||
float friis_index_for_ap(const std::string &ap_mac) const ;
|
float friis_index_for_ap(const std::string &ap_mac) const ;
|
||||||
/// Compute the Friis indexes sum for the given AccessPoint
|
/// Computes the Friis indexes sum for the given AccessPoint
|
||||||
float friis_indexes_for_ap(
|
float friis_indexes_for_ap(
|
||||||
const AccessPoint &ap, const double &const_term,
|
const AccessPoint &ap, const double &const_term,
|
||||||
int &nb_indexes) const ;
|
int &nb_indexes) const ;
|
||||||
|
|
|
@ -56,7 +56,7 @@ bool Result::operator==(const Result &source) const
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return the result as a CSV string, \em without trailing '\n'.
|
* @return The result as a CSV string, \em without trailing '\n'.
|
||||||
*/
|
*/
|
||||||
const string Result::to_csv() const
|
const string Result::to_csv() const
|
||||||
{
|
{
|
||||||
|
|
|
@ -46,7 +46,7 @@ bool ResultList::operator==(const ResultList &source) const
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return the results as a CSV string, \em without trailing '\n'.
|
* @return The results as a CSV string, \em without trailing '\n'.
|
||||||
*/
|
*/
|
||||||
const string ResultList::to_csv() const
|
const string ResultList::to_csv() const
|
||||||
{
|
{
|
||||||
|
|
|
@ -50,7 +50,7 @@ TextFileReader::~TextFileReader()
|
||||||
* If the first non-blank character of a line is a #, then the line is
|
* If the first non-blank character of a line is a #, then the line is
|
||||||
* skipped (note that comments at the end of a line are *not* handled).
|
* skipped (note that comments at the end of a line are *not* handled).
|
||||||
* @param text Output argument; unchanged in case of error.
|
* @param text Output argument; unchanged in case of error.
|
||||||
* @return false in case of error, true else.
|
* @return \em false in case of error, \em true else.
|
||||||
*/
|
*/
|
||||||
bool TextFileReader::read_nonblank_line(string &text)
|
bool TextFileReader::read_nonblank_line(string &text)
|
||||||
{
|
{
|
||||||
|
|
|
@ -47,8 +47,8 @@ TextFileWriter::~TextFileWriter()
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return true if the string has been written successfuly, or false
|
* @return \em true if the string has been written successfuly, or
|
||||||
* if not.
|
* \em false if not.
|
||||||
*/
|
*/
|
||||||
bool TextFileWriter::write_text(const string &text)
|
bool TextFileWriter::write_text(const string &text)
|
||||||
{
|
{
|
||||||
|
|
Loading…
Reference in New Issue