Some more work on the Doxygen version of the haiku_book.
I will keep working on the Docbook version, but as I'm still not completely comfortable with that as final choice, I'm playing around with this as well. The String.cpp file contained doxygen documentation for almost all methods, I copied those to a new file (string.dox) and grouped them accordingly. (Done because Axel is absolutely against in-header or in-source docs) Integrated the BMidiConsumer and BMidiLocalConsumer class into the same file (like I did now to the producers), since I think it's better to keep a 1:1 relation with the headers. Removed the mididefs.dox file and replaced it with the midi2/Midi2Defs.dox file which actually documents the Midi2Defs.h file, rather than contain a custom page that was somewhat hard to find. Please see http://www.myhouserules.nl/haiku_book/index.html for a generated book from the current source. I actually quite like the output so far, though I'm aware of the fact that I needed to perform some tricks to let Doxygen get to this point. git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@19651 a95241bf-73f2-0310-859d-f6bbb57e9c96
This commit is contained in:
Niels Sascha Reedijk
@@ -1,84 +1,84 @@
|
||||
/*!
|
||||
\file StopWatch.h
|
||||
\ingroup support
|
||||
\ingroup libbe
|
||||
\brief Provides the BStopWatch class.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\class BStopWatch
|
||||
\ingroup support
|
||||
\ingroup libbe
|
||||
\brief A timer class.
|
||||
|
||||
This class provides method to time events. The interface is designed to behave like a physical stopwatch. It is especially useful for debugging certain parts of your code, since it can behave like a 'cheap' profiler.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn BStopWatch::BStopWatch(const char *name, bool silent)
|
||||
\brief Constructs a BStopWatch object and starts the timer.
|
||||
|
||||
The constructor creates a clean BStopWatch object. This object
|
||||
can be given a name. As soon as the object is created, the time
|
||||
will start ticking away. This class is designed to be usuable as a primitive profiling tool.
|
||||
If you are profiling your code with this class, pass true as the
|
||||
silentparameter. Whenever the object is destroyed, information on
|
||||
the elapsed time will be streamed to standard output.
|
||||
|
||||
\param name The name you want to give this object. You may pass NULL.
|
||||
\param silent Pass true if you want to use this object as a simple profiler.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn BStopWatch::~BStopWatch()
|
||||
Destroys the object. If the object was constructed with the parameter
|
||||
silent set t to false, this destructor will print
|
||||
information on the elapsed time to standard output.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn void BStopWatch::Resume()
|
||||
\brief Resumes the timer when it is in a suspended state.
|
||||
\sa Suspend()
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn void BStopWatch::Suspend()
|
||||
\brief Suspends the timer.
|
||||
\sa Resume()
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn bigtime_t BStopWatch::Lap()
|
||||
\brief Start a new lap.
|
||||
|
||||
This method sets a lap. With the current implementation you are unable to actually
|
||||
retrieve the timings of the laps. This is only printed to the standard output when the
|
||||
object is destroyed. Thus making this tool only usuable for use when doing some
|
||||
profiling.
|
||||
|
||||
\attention Please note that the current implementation is limited to 10 laps. The value returned
|
||||
is the time that has passed since the timer was started (and not the time that has
|
||||
passed since the last lap). Any lap call beyond the 10th lap will overwrite the last
|
||||
value. Note that if the timer is suspended, nothing happens and the method will return 0.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn bigtime_t BStopWatch::ElapsedTime() const
|
||||
\brief Get the elapsed time the object has counted.
|
||||
\return The elapsed time in microseconds.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn void BStopWatch::Reset()
|
||||
\brief Restart the timer
|
||||
|
||||
Resets the object: it clears the start time, it clears the stored laps and it restarts
|
||||
the timer.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn const char *BStopWatch::Name() const
|
||||
\brief Get the name
|
||||
\return the name given to the object at creation time.
|
||||
/*!
|
||||
\file StopWatch.h
|
||||
\ingroup support
|
||||
\ingroup libbe
|
||||
\brief Provides the BStopWatch class.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\class BStopWatch
|
||||
\ingroup support
|
||||
\ingroup libbe
|
||||
\brief A timer class.
|
||||
|
||||
This class provides method to time events. The interface is designed to behave like a physical stopwatch. It is especially useful for debugging certain parts of your code, since it can behave like a 'cheap' profiler.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn BStopWatch::BStopWatch(const char *name, bool silent)
|
||||
\brief Constructs a BStopWatch object and starts the timer.
|
||||
|
||||
The constructor creates a clean BStopWatch object. This object
|
||||
can be given a name. As soon as the object is created, the time
|
||||
will start ticking away. This class is designed to be usuable as a primitive profiling tool.
|
||||
If you are profiling your code with this class, pass true as the
|
||||
silentparameter. Whenever the object is destroyed, information on
|
||||
the elapsed time will be streamed to standard output.
|
||||
|
||||
\param name The name you want to give this object. You may pass NULL.
|
||||
\param silent Pass true if you want to use this object as a simple profiler.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn BStopWatch::~BStopWatch()
|
||||
Destroys the object. If the object was constructed with the parameter
|
||||
silent set t to false, this destructor will print
|
||||
information on the elapsed time to standard output.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn void BStopWatch::Resume()
|
||||
\brief Resumes the timer when it is in a suspended state.
|
||||
\sa Suspend()
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn void BStopWatch::Suspend()
|
||||
\brief Suspends the timer.
|
||||
\sa Resume()
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn bigtime_t BStopWatch::Lap()
|
||||
\brief Start a new lap.
|
||||
|
||||
This method sets a lap. With the current implementation you are unable to actually
|
||||
retrieve the timings of the laps. This is only printed to the standard output when the
|
||||
object is destroyed. Thus making this tool only usuable for use when doing some
|
||||
profiling.
|
||||
|
||||
\attention Please note that the current implementation is limited to 10 laps. The value returned
|
||||
is the time that has passed since the timer was started (and not the time that has
|
||||
passed since the last lap). Any lap call beyond the 10th lap will overwrite the last
|
||||
value. Note that if the timer is suspended, nothing happens and the method will return 0.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn bigtime_t BStopWatch::ElapsedTime() const
|
||||
\brief Get the elapsed time the object has counted.
|
||||
\return The elapsed time in microseconds.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn void BStopWatch::Reset()
|
||||
\brief Restart the timer
|
||||
|
||||
Resets the object: it clears the start time, it clears the stored laps and it restarts
|
||||
the timer.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\fn const char *BStopWatch::Name() const
|
||||
\brief Get the name
|
||||
\return the name given to the object at creation time.
|
||||
*/
|
||||
+995
-186
File diff suppressed because it is too large
Load Diff
+129
-129
@@ -1,129 +1,129 @@
|
||||
/*!
|
||||
\file TypeConstants.h
|
||||
\ingroup support
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_ANY_TYPE
|
||||
\brief General type when the exact contents is not yet known.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_BOOL_TYPE
|
||||
\brief Boolean value
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_CHAR_TYPE
|
||||
\brief Represents the \c char type
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_COLOR_8_BIT_TYPE
|
||||
\brief Represents a one-byte colour
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_DOUBLE_TYPE
|
||||
\brief Represents the \c double type
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_FLOAT_TYPE
|
||||
\brief Represents the \c float type
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_GRAYSCALE_8_BIT_TYPE
|
||||
\brief Represents a byte-long grayscale value
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_INT16_TYPE
|
||||
\brief Represents a \c short type
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_INT32_TYPE
|
||||
\brief Represents a \c long type
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_INT64_TYPE
|
||||
\brief Represents a \c long \c long type
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_INT8_TYPE
|
||||
\brief Represents a \c char type used for integer storage
|
||||
*/
|
||||
|
||||
|
||||
|
||||
// Todo: the rest of the types
|
||||
|
||||
/*! @{
|
||||
\name System-wide MIME types for handling URLs
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_URL_HTTP
|
||||
\brief application/x-vnd.Be.URL.http
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_URL_HTTPS
|
||||
\brief application/x-vnd.Be.URL.https
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_URL_FTP
|
||||
\brief application/x-vnd.Be.URL.ftp
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_URL_GOPHER
|
||||
\brief application/x-vnd.Be.URL.gopher
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_URL_MAILTO
|
||||
\brief application/x-vnd.Be.URL.mailto
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_URL_NEWS
|
||||
\brief application/x-vnd.Be.URL.news
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_URL_NNTP
|
||||
\brief application/x-vnd.Be.URL.nntp
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_URL_TELNET
|
||||
\brief application/x-vnd.Be.URL.telnet
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_URL_RLOGIN
|
||||
\brief application/x-vnd.Be.URL.rlogin
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_URL_TN3270
|
||||
\brief application/x-vnd.Be.URL.tn3270
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_URL_WAIS
|
||||
\brief application/x-vnd.Be.URL.wais
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_URL_FILE
|
||||
\brief application/x-vnd.Be.URL.file
|
||||
*/
|
||||
|
||||
//! @}
|
||||
/*!
|
||||
\file TypeConstants.h
|
||||
\ingroup support
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_ANY_TYPE
|
||||
\brief General type when the exact contents is not yet known.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_BOOL_TYPE
|
||||
\brief Boolean value
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_CHAR_TYPE
|
||||
\brief Represents the \c char type
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_COLOR_8_BIT_TYPE
|
||||
\brief Represents a one-byte colour
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_DOUBLE_TYPE
|
||||
\brief Represents the \c double type
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_FLOAT_TYPE
|
||||
\brief Represents the \c float type
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_GRAYSCALE_8_BIT_TYPE
|
||||
\brief Represents a byte-long grayscale value
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_INT16_TYPE
|
||||
\brief Represents a \c short type
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_INT32_TYPE
|
||||
\brief Represents a \c long type
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_INT64_TYPE
|
||||
\brief Represents a \c long \c long type
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_INT8_TYPE
|
||||
\brief Represents a \c char type used for integer storage
|
||||
*/
|
||||
|
||||
|
||||
|
||||
// Todo: the rest of the types
|
||||
|
||||
/*! @{
|
||||
\name System-wide MIME types for handling URLs
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_URL_HTTP
|
||||
\brief application/x-vnd.Be.URL.http
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_URL_HTTPS
|
||||
\brief application/x-vnd.Be.URL.https
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_URL_FTP
|
||||
\brief application/x-vnd.Be.URL.ftp
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_URL_GOPHER
|
||||
\brief application/x-vnd.Be.URL.gopher
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_URL_MAILTO
|
||||
\brief application/x-vnd.Be.URL.mailto
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_URL_NEWS
|
||||
\brief application/x-vnd.Be.URL.news
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_URL_NNTP
|
||||
\brief application/x-vnd.Be.URL.nntp
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_URL_TELNET
|
||||
\brief application/x-vnd.Be.URL.telnet
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_URL_RLOGIN
|
||||
\brief application/x-vnd.Be.URL.rlogin
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_URL_TN3270
|
||||
\brief application/x-vnd.Be.URL.tn3270
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_URL_WAIS
|
||||
\brief application/x-vnd.Be.URL.wais
|
||||
*/
|
||||
|
||||
/*!
|
||||
\var B_URL_FILE
|
||||
\brief application/x-vnd.Be.URL.file
|
||||
*/
|
||||
|
||||
//! @}
|
||||
|
||||
Reference in New Issue
Block a user