ws-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Ws Wiki] Update of "FrontPage/Axis2C/apidocs" by senaka
Date Sun, 17 Feb 2008 16:11:45 GMT
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Ws Wiki" for change notification.

The following page has been changed by senaka:
http://wiki.apache.org/ws/FrontPage/Axis2C/apidocs

------------------------------------------------------------------------------
  
  === Documenting Convention ===
  
- TODO: need to agree on a convention.
+ Below is the convention that should be followed. This is enforced to make sure that your
comments are doxygen compatible. The conventions are enforced only for headers, and therefore
does not affect source files.
  
  ==== File Names ====
  
  {{{
- /** @file <file_name> */
+     /** @file <file_name> */
  }}}
  
  Ex:-
  
  {{{
- /** @file axis2_msg_ctx.h */
+     /** @file axis2_msg_ctx.h */
  }}}
  
  ==== Groups ====
  
- ==== Defines ====
+ Grouping of headers is not an easy task. Each header will belong to a module and each module
will belong to the base.
  
+ Ex:-
+ 
+ {{{
+     /**
+       * @defgroup axis2_addr WS-Addressing
+       * @ingroup axis2
+       * @{
+       * @}
+       */
+ 
+     /**
+       * @defgroup axis2_addr_consts WS-Addressing related constants
+       * @ingroup axis2_addr
+       * @{
+       */
+ }}}
+ 
+ However, the addition of a module to the base group ""MUST BE DONE ONLY ONCE"". Therefore
the portion,
+ 
+ {{{
+     /**
+       * @defgroup axis2_addr WS-Addressing
+       * @ingroup axis2
+       * @{
+       * @}
+       */
+ }}}
+ 
+ must not appear any where else.
+ 
+ ===== Adding a module to base =====
+ 
+ {{{
+     /**
+       * @defgroup <module_name> <brief>
+       * @ingroup axis2
+       * @{
+       * @}
+       */
+ }}}
+ 
+ ===== Adding a file to module =====
+ 
+ {{{
+     /**
+       * @defgroup <file_name> <brief>
+       * @ingroup <module_name>
+       * <expanded description>
+       * @{
+       */
+ }}}
+ 
- ==== Type Definitions ====
+ ==== Defines/Type Definitions ====
+ 
+ {{{
+     /** <description> */
+ }}}
  
  ==== Methods ====
  
+ TODO: need to agree on a convention.
+ 
  ==== Global Variables ====
  
+ TODO: need to agree on a convention.
+ 
  ==== Other ====
+ 
+ To mark the end of a file, you must add this at the bottom.
+ 
+ {{{
+     /** @} */
+ }}}
  
  
  === Finalized Headers ===

---------------------------------------------------------------------
To unsubscribe, e-mail: general-unsubscribe@ws.apache.org
For additional commands, e-mail: general-help@ws.apache.org


Mime
View raw message