Skip to content

Commit

Permalink
- Doxygen updates on core files
Browse files Browse the repository at this point in the history
- Add project name to doxygen in Makefile
  • Loading branch information
oej committed Oct 19, 2009
1 parent 89f4581 commit 5a03489
Show file tree
Hide file tree
Showing 22 changed files with 419 additions and 362 deletions.
1 change: 1 addition & 0 deletions Makefile.rules
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,7 @@ doxygen:
# disable call graphes, because of the DOT dependencies
(cat ./$(COREPATH)/doc/doxygen/ser.doxygen; \
echo "HAVE_DOT=no" ;\
echo "PROJECT_NAME=SIP-ROUTER" ;\
echo "PROJECT_NUMBER=$(NAME)-$(RELEASE)" )| doxygen -
-@echo "Doxygen documentation created"

Expand Down
1 change: 1 addition & 0 deletions action.c
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@
* 2009-05-04 switched IF_T to rval_expr (andrei)
* 2009-09-15 added SET_{FWD,RPL}_NO_CONNECT, SET_{FWD,RPL}_CLOSE (andrei)
*/

/*!
* \file
* \brief SIP-router core ::
Expand Down
7 changes: 7 additions & 0 deletions action.h
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,13 @@
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/

/*!
* \file
* \brief SIP-router core ::
* \ingroup core
* Module: \ref core
*/


#ifndef action_h
#define action_h
Expand Down
12 changes: 11 additions & 1 deletion atomic_ops.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,18 @@
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/

/*!
* \file
* \brief SIP-router core :: Atomic operations and memory barriers
* \ingroup core
* Module: \ref core
* See \ref atomicops
*/

/*
* atomic operations and memory barriers
* \page atomicops Atomic operations and memory barriers
*
* WARNING: atomic ops do not include memory barriers
*
* memory barriers:
Expand Down
17 changes: 11 additions & 6 deletions atomic_ops_init.h
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,15 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
/*
* atomic_ops init functions
* (needed for lock intializing if no native asm locks are available
* for the current arch./compiler combination, see atomic_ops.c)
/*!
* \file
* \brief SIP-router core :: atomic_ops init functions
*
* \ingroup core
* Module: \ref core
*
* Needed for lock intializing if no native asm locks are available
* for the current arch./compiler combination, see \ref atomic_ops.c
*/
/*
* History:
Expand All @@ -38,9 +43,9 @@
#ifndef __atomic_ops_init_h
#define __atomic_ops_init_h

/* init atomic ops */
/*! \brief init atomic ops */
int init_atomic_ops();
/* destroy atomic ops (e.g. frees the locks, if locks are used) */
/*! \brief destroy atomic ops (e.g. frees the locks, if locks are used) */
void destroy_atomic_ops();

#endif
2 changes: 1 addition & 1 deletion basex.c
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
*/
/*!
* \file
* \brief SIP-router core ::
* \brief SIP-router core :: convert/decode to/from ascii using various bases
* \ingroup core
* Module: \ref core
*/
Expand Down
Loading

0 comments on commit 5a03489

Please sign in to comment.