Update API documentation and Doxyfile to improve the output.
git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@18822 a95241bf-73f2-0310-859d-f6bbb57e9c96
This commit is contained in:
@@ -1,4 +1,7 @@
|
||||
/** \file parsedate.h
|
||||
/*!
|
||||
\file parsedate.h
|
||||
\ingroup support
|
||||
\ingroup libroot
|
||||
\brief date parsing functions
|
||||
|
||||
This is a set a functions for parsing date strings in various formats.
|
||||
|
||||
@@ -1,12 +1,10 @@
|
||||
/** \page support The Support Kit
|
||||
/*!
|
||||
\ingroup support
|
||||
\page supportintro The Support Kit
|
||||
|
||||
The Support Kit provides a handy set of functions and classes that you can
|
||||
use in your applications. It is part of both, libbe.so and libroot.so - a
|
||||
clear distinction of where you'll find what is still to be written/created.
|
||||
Documentation is avaible for the following parts:
|
||||
|
||||
- \ref parsedate.h Date parsing functions
|
||||
- \ref syslog.h system logging capabilities
|
||||
use in your applications.
|
||||
|
||||
This section is still under construction.
|
||||
*/
|
||||
|
||||
|
||||
@@ -1,4 +1,7 @@
|
||||
/** \file syslog.h
|
||||
/*!
|
||||
\file syslog.h
|
||||
\ingroup support
|
||||
\ingroup libroot
|
||||
\brief System logging capabilities
|
||||
|
||||
The functions described here are interacting with the syslog_daemon, a server
|
||||
@@ -6,30 +9,30 @@ that provides the system logging capabilities.
|
||||
The log can be found in /var/log/syslog.
|
||||
*/
|
||||
|
||||
/** \fn void closelog(void)
|
||||
/*! \fn void closelog(void)
|
||||
\brief Closes the current log session
|
||||
*/
|
||||
|
||||
/** \fn void openlog(const char *ident, int options, int facility)
|
||||
/*! \fn void openlog(const char *ident, int options, int facility)
|
||||
\brief Starts a log session, and sets some output options
|
||||
|
||||
Like openlog_thread() this function defines the log session in thread context; the
|
||||
global options set by openlog_team() are not affected by this function.
|
||||
*/
|
||||
|
||||
/** \fn int setlogmask(int priorityMask)
|
||||
/*! \fn int setlogmask(int priorityMask)
|
||||
\brief sets the logging priority mask
|
||||
*/
|
||||
|
||||
/** \fn void syslog(int priority, const char *message, ...)
|
||||
/*! \fn void syslog(int priority, const char *message, ...)
|
||||
\brief sends a message to the system log
|
||||
*/
|
||||
|
||||
/** \fn void closelog_team(void)
|
||||
/*! \fn void closelog_team(void)
|
||||
\brief Closes the log
|
||||
*/
|
||||
|
||||
/** \fn void openlog_team(const char *ident, int logopt, int facility)
|
||||
/*! \fn void openlog_team(const char *ident, int logopt, int facility)
|
||||
\brief Starts a log session, and sets some output options
|
||||
|
||||
This function defines the team-wide logging options. Thread local sessions
|
||||
@@ -37,26 +40,26 @@ started with openlog() or openlog_thread() will inherit the options of the
|
||||
global session.
|
||||
*/
|
||||
|
||||
/** \fn void log_team(int priority, const char *message, ...)
|
||||
/*! \fn void log_team(int priority, const char *message, ...)
|
||||
\brief sends a message to the system log
|
||||
*/
|
||||
|
||||
/** \fn int setlogmask_team(int priorityMask)
|
||||
/*! \fn int setlogmask_team(int priorityMask)
|
||||
\brief sets the logging priority mask
|
||||
*/
|
||||
|
||||
/** \fn void closelog_thread(void)
|
||||
/*! \fn void closelog_thread(void)
|
||||
\brief Closes the log
|
||||
*/
|
||||
|
||||
/** \fn void openlog_thread(const char *ident, int logopt, int facility)
|
||||
/*! \fn void openlog_thread(const char *ident, int logopt, int facility)
|
||||
\brief Starts a log session, and sets some output options
|
||||
*/
|
||||
|
||||
/** \fn void log_thread(int priority, const char *message, ...)
|
||||
/*! \fn void log_thread(int priority, const char *message, ...)
|
||||
\brief sends a message to the system log
|
||||
*/
|
||||
|
||||
/** \fn int setlogmask_thread(int priorityMask)
|
||||
/*! \fn int setlogmask_thread(int priorityMask)
|
||||
\brief sets the logging priority mask
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user