Author: kpvdr
Date: 2009-01-26 07:23:05 -0500 (Mon, 26 Jan 2009)
New Revision: 3072
Modified:
store/trunk/cpp/lib/jrnl/rfc.hpp
store/trunk/cpp/lib/jrnl/rrfc.hpp
Log:
Fixes for some doxygen comment tags
Modified: store/trunk/cpp/lib/jrnl/rfc.hpp
===================================================================
--- store/trunk/cpp/lib/jrnl/rfc.hpp 2009-01-23 14:04:11 UTC (rev 3071)
+++ store/trunk/cpp/lib/jrnl/rfc.hpp 2009-01-26 12:23:05 UTC (rev 3072)
@@ -114,22 +114,22 @@
virtual void finalize();
/**
- * /brief Check initialization state: true = Not Uninitialized, ie Initialized or
Active; false = Uninitialized.
+ * \brief Check initialization state: true = Not Uninitialized, ie Initialized or
Active; false = Uninitialized.
*/
virtual inline bool is_init() const { return _lpmp->is_init(); }
/**
- * /brief Check active state: true = Initialized and _curr_fc not null; false
otherwise.
+ * \brief Check active state: true = Initialized and _curr_fc not null; false
otherwise.
*/
virtual inline bool is_active() const { return _lpmp->is_init() &&
_curr_fc != 0; }
/**
- * /brief Sets the current file index and active fcntl object. Moves to state
Active.
+ * \brief Sets the current file index and active fcntl object. Moves to state
Active.
*/
virtual void set_findex(const u_int16_t fc_index);
/**
- * /brief Nulls the current file index and active fcntl pointer, moves to state
Inactive.
+ * \brief Nulls the current file index and active fcntl pointer, moves to state
Inactive.
*/
virtual void unset_findex();
Modified: store/trunk/cpp/lib/jrnl/rrfc.hpp
===================================================================
--- store/trunk/cpp/lib/jrnl/rrfc.hpp 2009-01-23 14:04:11 UTC (rev 3071)
+++ store/trunk/cpp/lib/jrnl/rrfc.hpp 2009-01-26 12:23:05 UTC (rev 3072)
@@ -109,33 +109,33 @@
void finalize();
/**
- * /brief Opens the file handle for reading a particular fid. Moves to state
open.
+ * \brief Opens the file handle for reading a particular fid. Moves to state
open.
*/
void set_findex(const u_int16_t fc_index);
/**
- * /brief Closes the read file handle and nulls the active fcntl pointer. Moves to
state closed.
+ * \brief Closes the read file handle and nulls the active fcntl pointer. Moves to
state closed.
*/
void unset_findex();
/**
- * /brief Check the state: true = open; false = closed.
+ * \brief Check the state: true = open; false = closed.
*/
inline bool is_active() const { return _curr_fc != 0 && _fh >= 0; }
/**
- * /brief Sets the validity flag which indicates that the read buffers contain
valid data for reading.
+ * \brief Sets the validity flag which indicates that the read buffers contain
valid data for reading.
*/
inline void set_invalid() { _valid = false; }
/**
- * /brief Resets the validity flag wich indicates that the read buffers are no
longer synchronized and cannot
+ * \brief Resets the validity flag wich indicates that the read buffers are no
longer synchronized and cannot
* be read whithout resynchronization.
*/
inline void set_valid() { _valid = true; }
/**
- * /brief Checks the read buffer validity status: true = valid, can be read; false
= invalid, synchronization
+ * \brief Checks the read buffer validity status: true = valid, can be read; false
= invalid, synchronization
* required.
*/
inline bool is_valid() const { return _valid; }
Show replies by date