doxygen-users

[Doxygen-users] How to obtain fully qualified namespace in Java class names

[Moreno P. <mpa...@es...>]

I would like to know, if it is possible, in which way can be generated a 
fully qualified namespace in Java class documentation.
I would like to know to which package a specific class belongs simply 
checking
the class documentation.

For example from the "Package List"

ACS Package List
Here are the packages with brief descriptions (if available):
abeans.models.acs.baci
abeans.models.acs.baci.generator
abeans.models.acs.baci.util
abeans.models.acs.baci.util.async


I select the package abeans.models.acs.baci

Package abeans.models.acs.baci

Interfaces
interface   Characteristics
interface   Invokeable
interface   ProxyContainer

Classes
class   BACILibrary
class   BACILibrary::LifeListener
class   Component
class   Component::ChildLifecycleListener
class   ComponentBeanInfo

and then the class Component .

Component Class Reference
Inheritance diagram for Component:
[Inheritance graph]


Is it possible to add more information in the title "Component Class 
Reference?"  like

abeans.models.acs.baci.Component Class Reference

The same problem, not a fully qualified namespace also appears in the 
"File List" menu.
If I select a class from this menu the corrispondend documentation is 
not providing infomration
about the package to which the class belongs.


Thanks in advance for your help

Re: [Doxygen-users] How to obtain fully qualified namespace in Java class names

[Dimitri v. H. <di...@st...>]

On Fri, Oct 31, 2003 at 11:05:38AM +0100, Moreno Pasquato wrote:
> I would like to know, if it is possible, in which way can be generated a 
> fully qualified namespace in Java class documentation.
> I would like to know to which package a specific class belongs simply 
> checking
> the class documentation.
> 
> For example from the "Package List"
> 
> ACS Package List
> Here are the packages with brief descriptions (if available):
> abeans.models.acs.baci
> abeans.models.acs.baci.generator
> abeans.models.acs.baci.util
> abeans.models.acs.baci.util.async

Doxygen already puts a fully qualified namespace in front of the class unless
HIDE_SCOPE_NAMES is enabled. If you want a list of all packages you need 
to document them. Here is how this can be done: 

Add a dummy file packages.dox somewhere, with the following contents:

---------------------------------------
/** @package abeans
 *  Beans
 */

/** @package abeans.modules
 *  Models
 */

/** @package abeans.modules.acs
 *  ACS
 */

/** @package abeans.modules.acs.baci
 *  Baci
 */
---------------------------------------

And make sure doxygen reads this file.

I hope this helps,

Regards,
  Dimitri

[Doxygen-users] How to use @code

[Moreno P. <mpa...@es...>]

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?


Here part of the file:


       /**
         * Creates a new instance of NCPublisher. Make sure you call
         * {@link #disconnect()} when you no longer need this event 
supplier object.
         * @code A>B<C
         * @param channelName
         *            Name of the notification channel events will be 
published to.
         * @param services
         *            This is used to get the name of the component and 
to access
         *            the ACS logging system.
         * @throws AcsJException
         *             There are literally dozens of CORBA exceptions 
that could be
         *             thrown by the NCPublisher class. Instead, these 
are converted
         *             into an ACS Error System exception for the 
developer's
         *             convenience.
         */
        public NCPublisher(String channelName, ContainerServicesBase 
services)
                        throws AcsJException {
                this(channelName, null, services);



Thanks
Moreno


-- 

Moreno Pasquato   
 
European Organization for Astronomical Research in the Southern Hemisphere

Software Development Division/Software Engineering Department

Karl-Schwarzschild-Strasse 2,  
D-85748 Garching bei Muenchen,  Germany. 

Email: mpa...@es...    
Tel: +49 89 3200-6603    
Fax: +49 89 3200-6514

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

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

[Moreno P. <mpa...@es...>]

Hi Brad,

thanks for you reply but I have forgotten to say that my code is java 
and that doxygen
properly works for

@param
{@link   }
and so on

Only that I have problems with {@code    }
It seems that is not supported despite it is written on 

version 1.5.8
id 553968: Added support for JavaDoc command {@code ... }



Brad Hards wrote:
> 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.

-- 

Moreno Pasquato   
 
European Organization for Astronomical Research in the Southern Hemisphere

Software Development Division/Software Engineering Department

Karl-Schwarzschild-Strasse 2,  
D-85748 Garching bei Muenchen,  Germany. 

Email: mpa...@es...    
Tel: +49 89 3200-6603    
Fax: +49 89 3200-6514

[Doxygen-users] Constants in C++

[Leach, D. J. <dl...@be...>]

In relation to my previous question about variables and constants being
documented as functions, I am wondering if it is possible for Doxygen to
show variable declarations that are "const" in a Constants section
rather than as variables.  Does anyone know how to do this?

Thanks,

Dan

17/12/2009This e-mail transmission contains information that is confidential and may be privileged.   It is intended only for the addressee(s) named above. If you receive this e-mail in error, please do not read, copy or disseminate it in any manner. If you are not the intended recipient, any disclosure, copying, distribution or use of the contents of this information is prohibited. Please reply to the message immediately by informing the sender that the message was misdirected. After replying, please erase it from your computer system. Your assistance in correcting this error is appreciated.

[Doxygen-users] tcl and bash script

[Moreno P. <mpa...@es...>]

Dear all,
does anybody of you know how to created documentation for tcl and bash 
script in doxygen?
Is there already a filter for them?

Thanks in advance
Moreno

-- 

Moreno Pasquato   
 
European Organization for Astronomical Research in the Southern Hemisphere

Software Development Division/Software Engineering Department

Karl-Schwarzschild-Strasse 2,  
D-85748 Garching bei Muenchen,  Germany. 

Email: mpa...@es...    
Tel: +49 89 3200-6603    
Fax: +49 89 3200-6514