Re: [Doxygen-users] How to use @code

[Brad H. <br...@fr...>]

On Wednesday 16 December 2009 20:13:46 Moreno Pasquato wrote:
> Hi,
> 
> I am testing version 1.6.1 since I saw that from version 1.5.8 on was
> added support for {@code }
> 
> I set JAVADOC_AUTOBRIEF=YES
> 
> but any time I use {@code } the entire documentation is screwed up
> and the documentation for Public Member Functions are not created at all
> Can someone please suggest me what I am doing wrong?
\code starts a block of code. You need to use \endcode to terminate the block.

Note that it is going to be interpreted as C/C++, which might not give you
exactly the effect you are looking for, as noted in
http://www.stack.nl/~dimitri/doxygen/commands.html#cmdcode

So it might look like something like:

/**
   \details Create a new attachment

   This function creates a new attachment to an existing message.

   \param obj_message the message to attach to
   \param obj_attach the attachment

   Both objects need to exist before you call this message. obj_message
   should be a valid message on the server. obj_attach needs to be
   initialised.

   \code
   enum MAPISTATUS         retval;
   mapi_object_t           obj_message;
   mapi_object_t           obj_attach;

   ... open or create the obj_message ...

   mapi_object_init(&obj_attach);
   retval = CreateAttach(&obj_message, &obj_attach);
   ... check the return value ...

   ... use SetProps() to set the attachment up ...
   ... perhaps OpenStream() / WriteStream() / CommitStream() on obj_attach ...

   // Save the changes to the attachment and then the message
   retval = SaveChangesAttachment(&obj_message, &obj_attach, KeepOpenReadOnly);
   ... check the return value ...
   retval = SaveChangesMessage(&obj_folder, &obj_message, KeepOpenReadOnly);
   ... check the return value ...
   \endcode

   \return MAPI_E_SUCCESS on success, otherwise MAPI error.

   \note Developers may also call GetLastError() to retrieve the last
   MAPI error code. Possible MAPI error codes are:
   - MAPI_E_NOT_INITIALIZED: MAPI subsystem has not been initialized
   - MAPI_E_CALL_FAILED: A network problem was encountered during the
     transaction

   \sa CreateMessage, GetAttachmentTable, OpenAttach, GetLastError
*/

The results of this can be seen at:
http://apidocs.openchange.org/libmapi/IMessage_8c.html#d59ad3d6701f33687a1eee772bd2bae7

Brad