doxygen-users — List for users of doxygen

[Doxygen-users] Fwd: Missing "refman" tex file for PDF output generation

[Hugo B. <hbo...@gm...>]

Hi all!

I'm trying to generate a PDF documentation of our project here.
What is going wrong is that when Latex output is generated, no "refman.tex"
file is generated.
Apparently there were no errors on doxygen log (only warnings).

This is the doxygen log: http://justpaste.it/dnt7

and after a "make pdf" command, I get the following:
c:\SIGA\trunk\docs\doxygen\latex>pdflatex refman
This is pdfTeX, Version 3.1415926-2.4-1.40.13 (MiKTeX 2.9)
entering extended mode
! I can't find file `refman'.
<*> refman

pdflatex couldn't find 'refman' because it doesn't exist. Doxygen couldn't
generate it for some mysterious reason I don't know why.

Any clues about that?

Thanks in advance,
Hugo Benício.

[Doxygen-users] C typedef struct generates warning

[mathog <ma...@ca...>]

When Doxygen sees documentation like this in a file upmf.h:

/** @brief EMF+ manual 2.2.1.1, Microsoft name: EmfPlusBrush Object
*/
typedef struct {
     uint32_t            Version;            //!< EmfPlusGraphicsVersion 
object
     uint32_t            Type;               //!< BrushType Enumeration
} U_PMF_BRUSH, *PU_PMF_BRUSH;

it shows up in the HTML under upmf.h (like this)

struct  	U_PMF_BRUSH
  	EMF+ manual 2.2.1.1, Microsoft name: EmfPlusBrush Object. More...

where the U_PMF_BRUSH instance is a link to a page showing Version and 
Type documentatoin.

There is also a warning:

upmf.h:1377: warning: Member PU_PMF_BRUSH (typedef) of file upmf.h is 
not documented.

What does that warning mean?  Near as I can tell Doxygen generated the 
right documentation, so what is Doxygen unhappy about here?

Thank you,

David Mathog
ma...@ca...
Manager, Sequence Analysis Facility, Biology Division, Caltech

Re: [Doxygen-users] Tilde in markdown table field causes unexpected output.

[Jeremy R. <jro...@gm...>]

Hello Albert,
     Thanks for the lightning-fast reply.
I'm using rev 1.8.5 Doxygen, with MARKDOWN_SUPPORT=YES
After setting the Doxygen factory defaults the table appeared correctly 
- very odd!
This confirms the old maxim that SW and HW problems disappear when you 
start to diagnose them.
I suggest closing this, and I'll report it again when it's reproducable.
Best wishes,

Jerry

Am 20.11.2013 15:21, schrieb Albert:
> Forgot to include the list
>
> On Wed, Nov 20, 2013 at 3:18 PM, Albert <alb...@gm... 
> <mailto:alb...@gm...>> wrote:
>
>     Hi Jeremy,
>
>     I tried with different version and with standard Doxyfile (doxygen
>     -g) but I did not see the behavior you describe.
>     Which version of doxygen are you using?
>     Anything special in your Doxyfile?
>
>     Albert
>
>
>     On Wed, Nov 20, 2013 at 2:53 PM, Jeremy Royston <jro...@gm...
>     <mailto:jro...@gm...>> wrote:
>
>         Doxygen outputs text in place of the expected table. The file
>         text is:
>
>         /*! \file
>             \brief Hardware definitions and macros.
>
>
>             The processor is an ATmega32U2. The pins and their
>         functions are:
>
>             | Pin | I/O  | Function |
>             | --: | :--: | :------- |
>             |  1  | I    |  ~RESET  |
>             | 28  | P    | VCC      |
>         */
>
>         The HTML output from the table is:
>
>         | Pin | I/O  | Function || --: | :--: | :------- ||  1  | I    |
>
>         It's the tilde symbol which causes the problem, after omitting
>         it, the table was output as expected.
>
>         Is this a bug or a special feature?
>         This question has also been posted in stackoverflow, no answer
>         yet. I couldn't find anything relevant in the manual.
>         Thanks for your help,
>
>         Jerry
>
>         ------------------------------------------------------------------------------
>         Shape the Mobile Experience: Free Subscription
>         Software experts and developers: Be at the forefront of tech
>         innovation.
>         Intel(R) Software Adrenaline delivers strategic insight and
>         game-changing
>         conversations that shape the rapidly evolving mobile
>         landscape. Sign up now.
>         http://pubads.g.doubleclick.net/gampad/clk?id=63431311&iu=/4140/ostg.clktrk
>         _______________________________________________
>         Doxygen-users mailing list
>         Dox...@li...
>         <mailto:Dox...@li...>
>         https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>
>

Re: [Doxygen-users] Tilde in markdown table field causes unexpected output.

[Albert <alb...@gm...>]

Forgot to include the list

On Wed, Nov 20, 2013 at 3:18 PM, Albert <alb...@gm...> wrote:

> Hi Jeremy,
>
> I tried with different version and with standard Doxyfile (doxygen -g) but
> I did not see the behavior you describe.
> Which version of doxygen are you using?
> Anything special in your Doxyfile?
>
> Albert
>
>
> On Wed, Nov 20, 2013 at 2:53 PM, Jeremy Royston <jro...@gm...> wrote:
>
>>  Doxygen outputs text in place of the expected table. The file text is:
>>
>> /*! \file
>>     \brief Hardware definitions and macros.
>>
>>
>>     The processor is an ATmega32U2. The pins and their functions are:
>>
>>     | Pin | I/O  | Function |
>>     | --: | :--: | :------- |
>>     |  1  | I    |  ~RESET  |
>>     | 28  | P    | VCC      |
>> */
>>
>> The HTML output from the table is:
>>
>> | Pin | I/O  | Function || --: | :--: | :------- ||  1  | I    |
>>
>> It's the tilde symbol which causes the problem, after omitting it, the
>> table was output as expected.
>>
>> Is this a bug or a special feature?
>> This question has also been posted in stackoverflow, no answer yet. I
>> couldn't find anything relevant in the manual.
>> Thanks for your help,
>>
>> Jerry
>>
>>
>> ------------------------------------------------------------------------------
>> Shape the Mobile Experience: Free Subscription
>> Software experts and developers: Be at the forefront of tech innovation.
>> Intel(R) Software Adrenaline delivers strategic insight and game-changing
>> conversations that shape the rapidly evolving mobile landscape. Sign up
>> now.
>>
>> http://pubads.g.doubleclick.net/gampad/clk?id=63431311&iu=/4140/ostg.clktrk
>> _______________________________________________
>> Doxygen-users mailing list
>> Dox...@li...
>> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>>
>>
>

[Doxygen-users] Tilde in markdown table field causes unexpected output.

[Jeremy R. <jro...@gm...>]

Doxygen outputs text in place of the expected table. The file text is:

/*! \file
     \brief Hardware definitions and macros.


     The processor is an ATmega32U2. The pins and their functions are:

     | Pin | I/O  | Function |
     | --: | :--: | :------- |
     |  1  | I    |  ~RESET  |
     | 28  | P    | VCC      |
*/

The HTML output from the table is:

| Pin | I/O  | Function || --: | :--: | :------- ||  1  | I    |

It's the tilde symbol which causes the problem, after omitting it, the 
table was output as expected.

Is this a bug or a special feature?
This question has also been posted in stackoverflow, no answer yet. I 
couldn't find anything relevant in the manual.
Thanks for your help,

Jerry

Re: [Doxygen-users] Strange indentation behaviour

[Albert <alb...@gm...>]

Hi Roger,

OK indeed the return type is aligned to the right. Good that it is clear
now.

Albert


On Wed, Nov 20, 2013 at 10:54 AM, Roger James
<ro...@be...>wrote:

>  Hi Albert,
>
> Doh, am I going completely stupid, of course it is aligning the function
> names and moving then across far enough to fill in the return type!!!!!!! I
> spent hours looking at this last night!!!!!
>
> Roger
>
>
>
> On 20/11/13 09:42, Albert wrote:
>
>  Hi Roger,
>
> Looked at the screenshot and the html pages (I'm using Firefox, newest
> version on windows) but I don't see the problem you are referring to.As far
> as I understand you are talking about the function prototypes and brief
> descriptions in the light blue part but I don't see here anything odd, I
> probably don't understand the problem you are referring to.
>
>  Albert
>
>
> On Wed, Nov 20, 2013 at 10:30 AM, Roger James <ro...@be...
> > wrote:
>
>>  Hi Albert,
>>
>> I am definitely using 1.8.4. I get the same result with my normal
>> Doxyfile, a -g Doxyfile, and no Doxyfile. I have zipped up a screen shot
>> and my test environment along with the generated output and put it here.
>>
>> https://dl.dropboxusercontent.com/u/84613021/doxytest.zip
>>
>> I wonder if this is a browser issue. I am using Firefox. I will try to
>> fire up virtualbox and see if I can check with a different browser and
>> maybe a windows install of doxygen.
>>
>> Thank you  for your response.
>>
>> Roger
>>
>>
>> On 20/11/13 09:01, Albert wrote:
>>
>>   Roger,
>>
>>  I tried your example with version 1.8.4  on windows (with doxygen -v you
>> get the version so please check to be 100% sure you use 1.8.4. Normally the
>> version is also mentioned at the bottom right of each HTML page) but I
>> didn't see anything special. I used a default Doxyfile  (i.e. one generated
>> with doxygen -g)..
>>  - Did you you use any special settings?
>>  - can you post an image signaling the problem?
>>
>>  Albert
>>
>>
>> On Tue, Nov 19, 2013 at 10:47 PM, Roger James <
>> ro...@be...> wrote:
>>
>>> Oops, I meant two say two indents further right!  Senior moment :-)
>>>
>>> Roger James <ro...@be...> wrote:
>>>
>>> >Help,
>>> >
>>> >I am really scratching my head over the indentation in the following
>>> >piece of code.
>>> >
>>> >If have tried dots, par commands, blank lines. Everything I could think
>>> >of. But the functions after the list in the @name block come out wrongly
>>> >indented. The first two functions (EnumerateMathPlugins and
>>> >SelectMathPlugin) come out two (approx) indents  (I am using spaces)
>>> >further to the left than the last sub list entry (The current selected
>>> >math plugin..) and the next function is not indented at all!
>>> >
>>> >You can verify this by saving this code as test.h and running doxygen
>>> >test.h (no config file). I think my doxygen version is 1.8.4 (Ubuntu
>>> 13.10).
>>> >
>>> >All help gratefully received.
>>> >
>>> >Roger
>>> >
>>> >#include <vector>
>>> >#include <string>
>>> >
>>> >/*!
>>> > * \class AlignmentSubsystem
>>> > * \brief Provides functions to manage the loading and initialisation
>>> of Alignment Subsystem plugin database and math modules. Also provides
>>> > * helper functions for telescope drivers using the the Alignment
>>> Subsystem.
>>> > *
>>> > * TODO see if we can detect if this class is being used by a client or
>>> a driver from RTTI
>>> > * so that we can access INDI properties appropriately
>>> > *
>>> > * \note It is intended that this class should be included as a base
>>> class alongside INDI::Telescope in derived
>>> > * telescope driver classes. In the same way the INDI::GuiderInterface
>>> class is used.
>>> > */
>>> >class AlignmentSubsystem
>>> >{
>>> >public:
>>> >    /*! @name Plugin management
>>> >     *  These functions are used to enumerate, load, and utilise math
>>> plugins.
>>> >     *  They are intended to be used solely in driver modules.
>>> >     *  The following INDI properties are used to communicate the
>>> plugin details to the client if required.
>>> >     *  - ALIGNMENT_SUBSYSTEM_MATH_PLUGINS\n
>>> >     *    A list of available plugins (switch)
>>> >     *  - ALIGNMENT_SUBSYSYSTEM_CURRENT_MATH_PLUGIN\n
>>> >     *    The current selected math plugin. Read/write if required
>>> (text)
>>> >     *  .
>>> >     *
>>> >     */
>>> >    ///@{
>>> >    /*!
>>> >     * \brief Return a list of the names of the available math plugins.
>>> >     * \param[out] MathPlugins Reference to a list of the names of the
>>> available math plugins.
>>> >     * \return False on failure
>>> >     */
>>> >    bool EnumerateMathPlugins(const std::vector<std::string>&
>>> MathPlugins);
>>> >
>>> >    /*!
>>> >     * \brief Selects, loads and initialises the named math plugin.
>>> >     * \param[in] MathPluginName The name of the required math plugin.
>>> >     * \return False on failure.
>>> >     */
>>> >    bool SelectMathPlugin(const std::string& MathPluginName);
>>> >
>>> >    /*!
>>> >     * \brief Get a pointer to the current math plugin.
>>> >     * \return NULL on failure.
>>> >     */
>>> >    const MathPlugin* GetMathPluginPointer(void);
>>> >    ///@}
>>> >
>>> >};
>>>
>>
>

Re: [Doxygen-users] Strange indentation behaviour

[Roger J. <ro...@be...>]

Hi Albert,

Doh, am I going completely stupid, of course it is aligning the function
names and moving then across far enough to fill in the return
type!!!!!!! I spent hours looking at this last night!!!!!

Roger


On 20/11/13 09:42, Albert wrote:
> Hi Roger,
>
> Looked at the screenshot and the html pages (I'm using Firefox, newest
> version on windows) but I don't see the problem you are referring
> to.As far as I understand you are talking about the function
> prototypes and brief descriptions in the light blue part but I don't
> see here anything odd, I probably don't understand the problem you are
> referring to.
>
> Albert
>
>
> On Wed, Nov 20, 2013 at 10:30 AM, Roger James
> <ro...@be... <mailto:ro...@be...>> wrote:
>
>     Hi Albert,
>
>     I am definitely using 1.8.4. I get the same result with my normal
>     Doxyfile, a -g Doxyfile, and no Doxyfile. I have zipped up a
>     screen shot and my test environment along with the generated
>     output and put it here.
>
>     https://dl.dropboxusercontent.com/u/84613021/doxytest.zip
>
>     I wonder if this is a browser issue. I am using Firefox. I will
>     try to fire up virtualbox and see if I can check with a different
>     browser and maybe a windows install of doxygen.
>
>     Thank you  for your response.
>
>     Roger
>
>
>     On 20/11/13 09:01, Albert wrote:
>>     Roger,
>>
>>     I tried your example with version 1.8.4  on windows (with doxygen
>>     -v you get the version so please check to be 100% sure you use
>>     1.8.4. Normally the version is also mentioned at the bottom right
>>     of each HTML page) but I didn't see anything special. I used a
>>     default Doxyfile  (i.e. one generated with doxygen -g)..
>>     - Did you you use any special settings?
>>     - can you post an image signaling the problem?
>>
>>     Albert
>>
>>
>>     On Tue, Nov 19, 2013 at 10:47 PM, Roger James
>>     <ro...@be...
>>     <mailto:ro...@be...>> wrote:
>>
>>         Oops, I meant two say two indents further right!  Senior
>>         moment :-)
>>
>>         Roger James <ro...@be...
>>         <mailto:ro...@be...>> wrote:
>>
>>         >Help,
>>         >
>>         >I am really scratching my head over the indentation in the
>>         following
>>         >piece of code.
>>         >
>>         >If have tried dots, par commands, blank lines. Everything I
>>         could think
>>         >of. But the functions after the list in the @name block come
>>         out wrongly
>>         >indented. The first two functions (EnumerateMathPlugins and
>>         >SelectMathPlugin) come out two (approx) indents  (I am using
>>         spaces)
>>         >further to the left than the last sub list entry (The
>>         current selected
>>         >math plugin..) and the next function is not indented at all!
>>         >
>>         >You can verify this by saving this code as test.h and
>>         running doxygen
>>         >test.h (no config file). I think my doxygen version is 1.8.4
>>         (Ubuntu 13.10).
>>         >
>>         >All help gratefully received.
>>         >
>>         >Roger
>>         >
>>         >#include <vector>
>>         >#include <string>
>>         >
>>         >/*!
>>         > * \class AlignmentSubsystem
>>         > * \brief Provides functions to manage the loading and
>>         initialisation of Alignment Subsystem plugin database and
>>         math modules. Also provides
>>         > * helper functions for telescope drivers using the the
>>         Alignment Subsystem.
>>         > *
>>         > * TODO see if we can detect if this class is being used by
>>         a client or a driver from RTTI
>>         > * so that we can access INDI properties appropriately
>>         > *
>>         > * \note It is intended that this class should be included
>>         as a base class alongside INDI::Telescope in derived
>>         > * telescope driver classes. In the same way the
>>         INDI::GuiderInterface class is used.
>>         > */
>>         >class AlignmentSubsystem
>>         >{
>>         >public:
>>         >    /*! @name Plugin management
>>         >     *  These functions are used to enumerate, load, and
>>         utilise math plugins.
>>         >     *  They are intended to be used solely in driver modules.
>>         >     *  The following INDI properties are used to
>>         communicate the plugin details to the client if required.
>>         >     *  - ALIGNMENT_SUBSYSTEM_MATH_PLUGINS\n
>>         >     *    A list of available plugins (switch)
>>         >     *  - ALIGNMENT_SUBSYSYSTEM_CURRENT_MATH_PLUGIN\n
>>         >     *    The current selected math plugin. Read/write if
>>         required (text)
>>         >     *  .
>>         >     *
>>         >     */
>>         >    ///@{
>>         >    /*!
>>         >     * \brief Return a list of the names of the available
>>         math plugins.
>>         >     * \param[out] MathPlugins Reference to a list of the
>>         names of the available math plugins.
>>         >     * \return False on failure
>>         >     */
>>         >    bool EnumerateMathPlugins(const
>>         std::vector<std::string>& MathPlugins);
>>         >
>>         >    /*!
>>         >     * \brief Selects, loads and initialises the named math
>>         plugin.
>>         >     * \param[in] MathPluginName The name of the required
>>         math plugin.
>>         >     * \return False on failure.
>>         >     */
>>         >    bool SelectMathPlugin(const std::string& MathPluginName);
>>         >
>>         >    /*!
>>         >     * \brief Get a pointer to the current math plugin.
>>         >     * \return NULL on failure.
>>         >     */
>>         >    const MathPlugin* GetMathPluginPointer(void);
>>         >    ///@}
>>         >
>>         >};
>>

Re: [Doxygen-users] Strange indentation behaviour

[Albert <alb...@gm...>]

Hi Roger,

Looked at the screenshot and the html pages (I'm using Firefox, newest
version on windows) but I don't see the problem you are referring to.As far
as I understand you are talking about the function prototypes and brief
descriptions in the light blue part but I don't see here anything odd, I
probably don't understand the problem you are referring to.

Albert


On Wed, Nov 20, 2013 at 10:30 AM, Roger James
<ro...@be...>wrote:

>  Hi Albert,
>
> I am definitely using 1.8.4. I get the same result with my normal
> Doxyfile, a -g Doxyfile, and no Doxyfile. I have zipped up a screen shot
> and my test environment along with the generated output and put it here.
>
> https://dl.dropboxusercontent.com/u/84613021/doxytest.zip
>
> I wonder if this is a browser issue. I am using Firefox. I will try to
> fire up virtualbox and see if I can check with a different browser and
> maybe a windows install of doxygen.
>
> Thank you  for your response.
>
> Roger
>
>
> On 20/11/13 09:01, Albert wrote:
>
>   Roger,
>
>  I tried your example with version 1.8.4  on windows (with doxygen -v you
> get the version so please check to be 100% sure you use 1.8.4. Normally the
> version is also mentioned at the bottom right of each HTML page) but I
> didn't see anything special. I used a default Doxyfile  (i.e. one generated
> with doxygen -g)..
>  - Did you you use any special settings?
>  - can you post an image signaling the problem?
>
>  Albert
>
>
> On Tue, Nov 19, 2013 at 10:47 PM, Roger James <ro...@be...
> > wrote:
>
>> Oops, I meant two say two indents further right!  Senior moment :-)
>>
>> Roger James <ro...@be...> wrote:
>>
>> >Help,
>> >
>> >I am really scratching my head over the indentation in the following
>> >piece of code.
>> >
>> >If have tried dots, par commands, blank lines. Everything I could think
>> >of. But the functions after the list in the @name block come out wrongly
>> >indented. The first two functions (EnumerateMathPlugins and
>> >SelectMathPlugin) come out two (approx) indents  (I am using spaces)
>> >further to the left than the last sub list entry (The current selected
>> >math plugin..) and the next function is not indented at all!
>> >
>> >You can verify this by saving this code as test.h and running doxygen
>> >test.h (no config file). I think my doxygen version is 1.8.4 (Ubuntu
>> 13.10).
>> >
>> >All help gratefully received.
>> >
>> >Roger
>> >
>> >#include <vector>
>> >#include <string>
>> >
>> >/*!
>> > * \class AlignmentSubsystem
>> > * \brief Provides functions to manage the loading and initialisation of
>> Alignment Subsystem plugin database and math modules. Also provides
>> > * helper functions for telescope drivers using the the Alignment
>> Subsystem.
>> > *
>> > * TODO see if we can detect if this class is being used by a client or
>> a driver from RTTI
>> > * so that we can access INDI properties appropriately
>> > *
>> > * \note It is intended that this class should be included as a base
>> class alongside INDI::Telescope in derived
>> > * telescope driver classes. In the same way the INDI::GuiderInterface
>> class is used.
>> > */
>> >class AlignmentSubsystem
>> >{
>> >public:
>> >    /*! @name Plugin management
>> >     *  These functions are used to enumerate, load, and utilise math
>> plugins.
>> >     *  They are intended to be used solely in driver modules.
>> >     *  The following INDI properties are used to communicate the plugin
>> details to the client if required.
>> >     *  - ALIGNMENT_SUBSYSTEM_MATH_PLUGINS\n
>> >     *    A list of available plugins (switch)
>> >     *  - ALIGNMENT_SUBSYSYSTEM_CURRENT_MATH_PLUGIN\n
>> >     *    The current selected math plugin. Read/write if required (text)
>> >     *  .
>> >     *
>> >     */
>> >    ///@{
>> >    /*!
>> >     * \brief Return a list of the names of the available math plugins.
>> >     * \param[out] MathPlugins Reference to a list of the names of the
>> available math plugins.
>> >     * \return False on failure
>> >     */
>> >    bool EnumerateMathPlugins(const std::vector<std::string>&
>> MathPlugins);
>> >
>> >    /*!
>> >     * \brief Selects, loads and initialises the named math plugin.
>> >     * \param[in] MathPluginName The name of the required math plugin.
>> >     * \return False on failure.
>> >     */
>> >    bool SelectMathPlugin(const std::string& MathPluginName);
>> >
>> >    /*!
>> >     * \brief Get a pointer to the current math plugin.
>> >     * \return NULL on failure.
>> >     */
>> >    const MathPlugin* GetMathPluginPointer(void);
>> >    ///@}
>> >
>> >};
>> >
>> >
>> >
>> >
>>
>> >------------------------------------------------------------------------------
>> >Shape the Mobile Experience: Free Subscription
>> >Software experts and developers: Be at the forefront of tech innovation.
>> >Intel(R) Software Adrenaline delivers strategic insight and game-changing
>> >conversations that shape the rapidly evolving mobile landscape. Sign up
>> now.
>> >
>> http://pubads.g.doubleclick.net/gampad/clk?id=63431311&iu=/4140/ostg.clktrk
>> >_______________________________________________
>> >Doxygen-users mailing list
>> >Dox...@li...
>> >https://lists.sourceforge.net/lists/listinfo/doxygen-users
>>
>> ------------------------------------------------------------------------------
>> Shape the Mobile Experience: Free Subscription
>> Software experts and developers: Be at the forefront of tech innovation.
>> Intel(R) Software Adrenaline delivers strategic insight and game-changing
>> conversations that shape the rapidly evolving mobile landscape. Sign up
>> now.
>>
>> http://pubads.g.doubleclick.net/gampad/clk?id=63431311&iu=/4140/ostg.clktrk
>> _______________________________________________
>> Doxygen-users mailing list
>> Dox...@li...
>> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>>
>
>
>

Re: [Doxygen-users] Strange indentation behaviour

[Roger J. <ro...@be...>]

Hi Albert,

I am definitely using 1.8.4. I get the same result with my normal
Doxyfile, a -g Doxyfile, and no Doxyfile. I have zipped up a screen shot
and my test environment along with the generated output and put it here.

https://dl.dropboxusercontent.com/u/84613021/doxytest.zip

I wonder if this is a browser issue. I am using Firefox. I will try to
fire up virtualbox and see if I can check with a different browser and
maybe a windows install of doxygen.

Thank you  for your response.

Roger

On 20/11/13 09:01, Albert wrote:
> Roger,
>
> I tried your example with version 1.8.4  on windows (with doxygen -v
> you get the version so please check to be 100% sure you use 1.8.4.
> Normally the version is also mentioned at the bottom right of each
> HTML page) but I didn't see anything special. I used a default
> Doxyfile  (i.e. one generated with doxygen -g)..
> - Did you you use any special settings?
> - can you post an image signaling the problem?
>
> Albert
>
>
> On Tue, Nov 19, 2013 at 10:47 PM, Roger James
> <ro...@be... <mailto:ro...@be...>> wrote:
>
>     Oops, I meant two say two indents further right!  Senior moment :-)
>
>     Roger James <ro...@be...
>     <mailto:ro...@be...>> wrote:
>
>     >Help,
>     >
>     >I am really scratching my head over the indentation in the following
>     >piece of code.
>     >
>     >If have tried dots, par commands, blank lines. Everything I could
>     think
>     >of. But the functions after the list in the @name block come out
>     wrongly
>     >indented. The first two functions (EnumerateMathPlugins and
>     >SelectMathPlugin) come out two (approx) indents  (I am using spaces)
>     >further to the left than the last sub list entry (The current
>     selected
>     >math plugin..) and the next function is not indented at all!
>     >
>     >You can verify this by saving this code as test.h and running doxygen
>     >test.h (no config file). I think my doxygen version is 1.8.4
>     (Ubuntu 13.10).
>     >
>     >All help gratefully received.
>     >
>     >Roger
>     >
>     >#include <vector>
>     >#include <string>
>     >
>     >/*!
>     > * \class AlignmentSubsystem
>     > * \brief Provides functions to manage the loading and
>     initialisation of Alignment Subsystem plugin database and math
>     modules. Also provides
>     > * helper functions for telescope drivers using the the Alignment
>     Subsystem.
>     > *
>     > * TODO see if we can detect if this class is being used by a
>     client or a driver from RTTI
>     > * so that we can access INDI properties appropriately
>     > *
>     > * \note It is intended that this class should be included as a
>     base class alongside INDI::Telescope in derived
>     > * telescope driver classes. In the same way the
>     INDI::GuiderInterface class is used.
>     > */
>     >class AlignmentSubsystem
>     >{
>     >public:
>     >    /*! @name Plugin management
>     >     *  These functions are used to enumerate, load, and utilise
>     math plugins.
>     >     *  They are intended to be used solely in driver modules.
>     >     *  The following INDI properties are used to communicate the
>     plugin details to the client if required.
>     >     *  - ALIGNMENT_SUBSYSTEM_MATH_PLUGINS\n
>     >     *    A list of available plugins (switch)
>     >     *  - ALIGNMENT_SUBSYSYSTEM_CURRENT_MATH_PLUGIN\n
>     >     *    The current selected math plugin. Read/write if
>     required (text)
>     >     *  .
>     >     *
>     >     */
>     >    ///@{
>     >    /*!
>     >     * \brief Return a list of the names of the available math
>     plugins.
>     >     * \param[out] MathPlugins Reference to a list of the names
>     of the available math plugins.
>     >     * \return False on failure
>     >     */
>     >    bool EnumerateMathPlugins(const std::vector<std::string>&
>     MathPlugins);
>     >
>     >    /*!
>     >     * \brief Selects, loads and initialises the named math plugin.
>     >     * \param[in] MathPluginName The name of the required math
>     plugin.
>     >     * \return False on failure.
>     >     */
>     >    bool SelectMathPlugin(const std::string& MathPluginName);
>     >
>     >    /*!
>     >     * \brief Get a pointer to the current math plugin.
>     >     * \return NULL on failure.
>     >     */
>     >    const MathPlugin* GetMathPluginPointer(void);
>     >    ///@}
>     >
>     >};
>     >
>     >
>     >
>     >
>     >------------------------------------------------------------------------------
>     >Shape the Mobile Experience: Free Subscription
>     >Software experts and developers: Be at the forefront of tech
>     innovation.
>     >Intel(R) Software Adrenaline delivers strategic insight and
>     game-changing
>     >conversations that shape the rapidly evolving mobile landscape.
>     Sign up now.
>     >http://pubads.g.doubleclick.net/gampad/clk?id=63431311&iu=/4140/ostg.clktrk
>     >_______________________________________________
>     >Doxygen-users mailing list
>     >Dox...@li...
>     <mailto:Dox...@li...>
>     >https://lists.sourceforge.net/lists/listinfo/doxygen-users
>     ------------------------------------------------------------------------------
>     Shape the Mobile Experience: Free Subscription
>     Software experts and developers: Be at the forefront of tech
>     innovation.
>     Intel(R) Software Adrenaline delivers strategic insight and
>     game-changing
>     conversations that shape the rapidly evolving mobile landscape.
>     Sign up now.
>     http://pubads.g.doubleclick.net/gampad/clk?id=63431311&iu=/4140/ostg.clktrk
>     _______________________________________________
>     Doxygen-users mailing list
>     Dox...@li...
>     <mailto:Dox...@li...>
>     https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>

Re: [Doxygen-users] Strange indentation behaviour

[Albert <alb...@gm...>]

Roger,

I tried your example with version 1.8.4  on windows (with doxygen -v you
get the version so please check to be 100% sure you use 1.8.4. Normally the
version is also mentioned at the bottom right of each HTML page) but I
didn't see anything special. I used a default Doxyfile  (i.e. one generated
with doxygen -g)..
- Did you you use any special settings?
- can you post an image signaling the problem?

Albert


On Tue, Nov 19, 2013 at 10:47 PM, Roger James
<ro...@be...>wrote:

> Oops, I meant two say two indents further right!  Senior moment :-)
>
> Roger James <ro...@be...> wrote:
>
> >Help,
> >
> >I am really scratching my head over the indentation in the following
> >piece of code.
> >
> >If have tried dots, par commands, blank lines. Everything I could think
> >of. But the functions after the list in the @name block come out wrongly
> >indented. The first two functions (EnumerateMathPlugins and
> >SelectMathPlugin) come out two (approx) indents  (I am using spaces)
> >further to the left than the last sub list entry (The current selected
> >math plugin..) and the next function is not indented at all!
> >
> >You can verify this by saving this code as test.h and running doxygen
> >test.h (no config file). I think my doxygen version is 1.8.4 (Ubuntu
> 13.10).
> >
> >All help gratefully received.
> >
> >Roger
> >
> >#include <vector>
> >#include <string>
> >
> >/*!
> > * \class AlignmentSubsystem
> > * \brief Provides functions to manage the loading and initialisation of
> Alignment Subsystem plugin database and math modules. Also provides
> > * helper functions for telescope drivers using the the Alignment
> Subsystem.
> > *
> > * TODO see if we can detect if this class is being used by a client or a
> driver from RTTI
> > * so that we can access INDI properties appropriately
> > *
> > * \note It is intended that this class should be included as a base
> class alongside INDI::Telescope in derived
> > * telescope driver classes. In the same way the INDI::GuiderInterface
> class is used.
> > */
> >class AlignmentSubsystem
> >{
> >public:
> >    /*! @name Plugin management
> >     *  These functions are used to enumerate, load, and utilise math
> plugins.
> >     *  They are intended to be used solely in driver modules.
> >     *  The following INDI properties are used to communicate the plugin
> details to the client if required.
> >     *  - ALIGNMENT_SUBSYSTEM_MATH_PLUGINS\n
> >     *    A list of available plugins (switch)
> >     *  - ALIGNMENT_SUBSYSYSTEM_CURRENT_MATH_PLUGIN\n
> >     *    The current selected math plugin. Read/write if required (text)
> >     *  .
> >     *
> >     */
> >    ///@{
> >    /*!
> >     * \brief Return a list of the names of the available math plugins.
> >     * \param[out] MathPlugins Reference to a list of the names of the
> available math plugins.
> >     * \return False on failure
> >     */
> >    bool EnumerateMathPlugins(const std::vector<std::string>&
> MathPlugins);
> >
> >    /*!
> >     * \brief Selects, loads and initialises the named math plugin.
> >     * \param[in] MathPluginName The name of the required math plugin.
> >     * \return False on failure.
> >     */
> >    bool SelectMathPlugin(const std::string& MathPluginName);
> >
> >    /*!
> >     * \brief Get a pointer to the current math plugin.
> >     * \return NULL on failure.
> >     */
> >    const MathPlugin* GetMathPluginPointer(void);
> >    ///@}
> >
> >};
> >
> >
> >
> >
>
> >------------------------------------------------------------------------------
> >Shape the Mobile Experience: Free Subscription
> >Software experts and developers: Be at the forefront of tech innovation.
> >Intel(R) Software Adrenaline delivers strategic insight and game-changing
> >conversations that shape the rapidly evolving mobile landscape. Sign up
> now.
> >
> http://pubads.g.doubleclick.net/gampad/clk?id=63431311&iu=/4140/ostg.clktrk
> >_______________________________________________
> >Doxygen-users mailing list
> >Dox...@li...
> >https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
> ------------------------------------------------------------------------------
> Shape the Mobile Experience: Free Subscription
> Software experts and developers: Be at the forefront of tech innovation.
> Intel(R) Software Adrenaline delivers strategic insight and game-changing
> conversations that shape the rapidly evolving mobile landscape. Sign up
> now.
> http://pubads.g.doubleclick.net/gampad/clk?id=63431311&iu=/4140/ostg.clktrk
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>

Re: [Doxygen-users] Strange indentation behaviour

[Roger J. <ro...@be...>]

Oops, I meant two say two indents further right!  Senior moment :-)

Roger James <ro...@be...> wrote:

>Help,
>
>I am really scratching my head over the indentation in the following
>piece of code.
>
>If have tried dots, par commands, blank lines. Everything I could think
>of. But the functions after the list in the @name block come out wrongly
>indented. The first two functions (EnumerateMathPlugins and
>SelectMathPlugin) come out two (approx) indents  (I am using spaces)
>further to the left than the last sub list entry (The current selected
>math plugin..) and the next function is not indented at all!
>
>You can verify this by saving this code as test.h and running doxygen
>test.h (no config file). I think my doxygen version is 1.8.4 (Ubuntu 13.10).
>
>All help gratefully received.
>
>Roger
>
>#include <vector>
>#include <string>
>
>/*!
> * \class AlignmentSubsystem
> * \brief Provides functions to manage the loading and initialisation of Alignment Subsystem plugin database and math modules. Also provides
> * helper functions for telescope drivers using the the Alignment Subsystem.
> *
> * TODO see if we can detect if this class is being used by a client or a driver from RTTI
> * so that we can access INDI properties appropriately
> *
> * \note It is intended that this class should be included as a base class alongside INDI::Telescope in derived
> * telescope driver classes. In the same way the INDI::GuiderInterface class is used.
> */
>class AlignmentSubsystem
>{
>public:
>    /*! @name Plugin management
>     *  These functions are used to enumerate, load, and utilise math plugins.
>     *  They are intended to be used solely in driver modules.
>     *  The following INDI properties are used to communicate the plugin details to the client if required.
>     *  - ALIGNMENT_SUBSYSTEM_MATH_PLUGINS\n
>     *    A list of available plugins (switch)
>     *  - ALIGNMENT_SUBSYSYSTEM_CURRENT_MATH_PLUGIN\n
>     *    The current selected math plugin. Read/write if required (text)
>     *  .
>     *
>     */
>    ///@{
>    /*!
>     * \brief Return a list of the names of the available math plugins.
>     * \param[out] MathPlugins Reference to a list of the names of the available math plugins.
>     * \return False on failure
>     */
>    bool EnumerateMathPlugins(const std::vector<std::string>& MathPlugins);
>
>    /*!
>     * \brief Selects, loads and initialises the named math plugin.
>     * \param[in] MathPluginName The name of the required math plugin.
>     * \return False on failure.
>     */
>    bool SelectMathPlugin(const std::string& MathPluginName);
>
>    /*!
>     * \brief Get a pointer to the current math plugin.
>     * \return NULL on failure.
>     */
>    const MathPlugin* GetMathPluginPointer(void);
>    ///@}
>
>};
>
>
>
>
>------------------------------------------------------------------------------
>Shape the Mobile Experience: Free Subscription
>Software experts and developers: Be at the forefront of tech innovation.
>Intel(R) Software Adrenaline delivers strategic insight and game-changing 
>conversations that shape the rapidly evolving mobile landscape. Sign up now. 
>http://pubads.g.doubleclick.net/gampad/clk?id=63431311&iu=/4140/ostg.clktrk
>_______________________________________________
>Doxygen-users mailing list
>Dox...@li...
>https://lists.sourceforge.net/lists/listinfo/doxygen-users

[Doxygen-users] Strange indentation behaviour

[Roger J. <ro...@be...>]

Help,

I am really scratching my head over the indentation in the following
piece of code.

If have tried dots, par commands, blank lines. Everything I could think
of. But the functions after the list in the @name block come out wrongly
indented. The first two functions (EnumerateMathPlugins and
SelectMathPlugin) come out two (approx) indents  (I am using spaces)
further to the left than the last sub list entry (The current selected
math plugin..) and the next function is not indented at all!

You can verify this by saving this code as test.h and running doxygen
test.h (no config file). I think my doxygen version is 1.8.4 (Ubuntu 13.10).

All help gratefully received.

Roger

#include <vector>
#include <string>

/*!
 * \class AlignmentSubsystem
 * \brief Provides functions to manage the loading and initialisation of Alignment Subsystem plugin database and math modules. Also provides
 * helper functions for telescope drivers using the the Alignment Subsystem.
 *
 * TODO see if we can detect if this class is being used by a client or a driver from RTTI
 * so that we can access INDI properties appropriately
 *
 * \note It is intended that this class should be included as a base class alongside INDI::Telescope in derived
 * telescope driver classes. In the same way the INDI::GuiderInterface class is used.
 */
class AlignmentSubsystem
{
public:
    /*! @name Plugin management
     *  These functions are used to enumerate, load, and utilise math plugins.
     *  They are intended to be used solely in driver modules.
     *  The following INDI properties are used to communicate the plugin details to the client if required.
     *  - ALIGNMENT_SUBSYSTEM_MATH_PLUGINS\n
     *    A list of available plugins (switch)
     *  - ALIGNMENT_SUBSYSYSTEM_CURRENT_MATH_PLUGIN\n
     *    The current selected math plugin. Read/write if required (text)
     *  .
     *
     */
    ///@{
    /*!
     * \brief Return a list of the names of the available math plugins.
     * \param[out] MathPlugins Reference to a list of the names of the available math plugins.
     * \return False on failure
     */
    bool EnumerateMathPlugins(const std::vector<std::string>& MathPlugins);

    /*!
     * \brief Selects, loads and initialises the named math plugin.
     * \param[in] MathPluginName The name of the required math plugin.
     * \return False on failure.
     */
    bool SelectMathPlugin(const std::string& MathPluginName);

    /*!
     * \brief Get a pointer to the current math plugin.
     * \return NULL on failure.
     */
    const MathPlugin* GetMathPluginPointer(void);
    ///@}

};

Re: [Doxygen-users] After upgrade to 1.8.5 : "input buffer overflow, can't enlarge buffer because scanner uses REJECT"

[Albert <alb...@gm...>]

Dear Mark,

Is the executable used a standard build doxygen executable or an executable
you build yourself.
Is it possible to post the offending source, converted source and Doxyfile?

Albert


On Fri, Nov 15, 2013 at 12:49 PM, Ziegler, Mark <Mar...@we...>wrote:

>  Hello,
>
>
>
> we have Jenkins running as our continuous integration system and Jenkins
> is launching doxygen as jobs.
>
> Our programming language for many projects is object pascal (Delphi) und
> so we have to use an input filter for doxygen.
>
>
>
> Project:
>
> Pas2Dox - https://sourceforge.net/projects/pas2dox/
>
>
>
> Config parameter for doxygen:
>
> INPUT_FILTER = "C:\doxygen\config\pas2dox-0.50rc1.exe"
>
>
>
> Doxygen has been working well for half a year. Doxygen version was 1.8.4.
>
> After upgrade to 1.8.5 jenkins reported doxygen jobs with errors.
>
>
>
> Log says:
>
> “…
>
> Parsing file C:/Jenkins/workspace/PowerCom
> Doxygen/source/U_EthernetHandler.pas...
>
> Exiting...
>
> input buffer overflow, can't enlarge buffer because scanner uses REJECT”
>
>
>
> So I downgraded to 1.8.4 again and run job with same source and everything
> went well.
>
>
>
> Can somebody help me?
>
>
>
>
>
> Mit freundlichen Grüßen  |  Best regards,
>
>
> *i.A. MARK ZIEGLER*
> Softwareentwicklung Produktbereich Profilieren   |  Software Department
> Product Unit Profiling
>
>
> *MICHAEL WEINIG AG*
> Weinigstrasse 2/4
> 97941 Tauberbischofsheim
> Germany
> Phone +49 (0) 9341 86-1726
> Fax +49 (0) 9341 86-31726
> mar...@we...
> www.weinig.com
>
>
>
>
> Vorsitzender des Aufsichtsrats: Dr. Thomas Bach
> Vorstand: Wolfgang Pöschl (Vorsitzender), Gerald Schmidt, Stephan Weber
> Sitz Tauberbischofsheim, Amtsgericht Mannheim HRB 560227
> UST / ID-Nr. DE 146587898
>
>
> ------------------------------------------------------------------------------
> DreamFactory - Open Source REST & JSON Services for HTML5 & Native Apps
> OAuth, Users, Roles, SQL, NoSQL, BLOB Storage and External API Access
> Free app hosting. Or install the open source package on any LAMP server.
> Sign up and see examples for AngularJS, jQuery, Sencha Touch and Native!
> http://pubads.g.doubleclick.net/gampad/clk?id=63469471&iu=/4140/ostg.clktrk
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>

[Doxygen-users] After upgrade to 1.8.5 : "input buffer overflow, can't enlarge buffer because scanner uses REJECT"

[Ziegler, M. <Mar...@we...>]

Hello,

we have Jenkins running as our continuous integration system and Jenkins is launching doxygen as jobs.
Our programming language for many projects is object pascal (Delphi) und so we have to use an input filter for doxygen.

Project:
Pas2Dox - https://sourceforge.net/projects/pas2dox/

Config parameter for doxygen:
INPUT_FILTER = "C:\doxygen\config\pas2dox-0.50rc1.exe"

Doxygen has been working well for half a year. Doxygen version was 1.8.4.
After upgrade to 1.8.5 jenkins reported doxygen jobs with errors.

Log says:
"...
Parsing file C:/Jenkins/workspace/PowerCom Doxygen/source/U_EthernetHandler.pas...
Exiting...
input buffer overflow, can't enlarge buffer because scanner uses REJECT"

So I downgraded to 1.8.4 again and run job with same source and everything went well.

Can somebody help me?


Mit freundlichen Grüßen  |  Best regards,


i.A. MARK ZIEGLER
Softwareentwicklung Produktbereich Profilieren   |  Software Department Product Unit Profiling


MICHAEL WEINIG AG
Weinigstrasse 2/4
97941 Tauberbischofsheim
Germany
Phone +49 (0) 9341 86-1726
Fax +49 (0) 9341 86-31726
mar...@we...<mailto:mar...@we...>
www.weinig.com<http://www.weinig.com>



Vorsitzender des Aufsichtsrats: Dr. Thomas Bach
Vorstand: Wolfgang Pöschl (Vorsitzender), Gerald Schmidt, Stephan Weber
Sitz Tauberbischofsheim, Amtsgericht Mannheim HRB 560227
UST / ID-Nr. DE 146587898

Re: [Doxygen-users] Way to capture differences in two generated documentation

[John Y. <jo...@ya...>]

Make sure you enable any option that will canonicalize your result (e.g.
sort alphabetically).

Render your documentation as xml.  Explore these links:
http://www.logilab.org/859/
https://github.com/amouat/diffxml

Render you documentation as html.  Explore links on this page:
http://www.w3.org/wiki/HtmlDiff

/john


On Thu, Nov 14, 2013 at 6:43 AM, Harpreet Singh Anand <
har...@no...> wrote:

> Hi everyone,
>
>
>
> I am using Doxygen to generate documentation for a small project.
>
>
>
> I am also changing the documentation in it.
>
>
>
> Is there a way, by which I can list what are the new documentation.
>
>
>
> Example: let say  I generate documentation DOC1 for project PRO at date D1
> and DOC2 for project PRO at date D2.
>
>
>
> Is there a way I can view the documentation differences in DOC1 and DOC2 ?
>
>
>
> Thanks & Regards,
>
> Harpreet Singh
>
>
>
> ________________________________
> NOTE: This message and its attachments are intended only for the individual or entity to which it is addressed, and may contain confidential information or forward looking statements in regards to product development. Information or statements contained within this email are for informational purposes only and do not represent a commitment, promise, or legal obligation of any kind by Atrenta, Inc. or its affiliates.
>
>
>
>
> ------------------------------------------------------------------------------
> DreamFactory - Open Source REST & JSON Services for HTML5 & Native Apps
> OAuth, Users, Roles, SQL, NoSQL, BLOB Storage and External API Access
> Free app hosting. Or install the open source package on any LAMP server.
> Sign up and see examples for AngularJS, jQuery, Sencha Touch and Native!
> http://pubads.g.doubleclick.net/gampad/clk?id=63469471&iu=/4140/ostg.clktrk
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>

[Doxygen-users] Way to capture differences in two generated documentation

[Harpreet S. A. <har...@no...>]

Hi everyone,

I am using Doxygen to generate documentation for a small project.

I am also changing the documentation in it.

Is there a way, by which I can list what are the new documentation.

Example: let say  I generate documentation DOC1 for project PRO at date D1 and DOC2 for project PRO at date D2.

Is there a way I can view the documentation differences in DOC1 and DOC2 ?

Thanks & Regards,
Harpreet Singh


________________________________
NOTE: This message and its attachments are intended only for the individual or entity to which it is addressed, and may contain confidential information or forward looking statements in regards to product development. Information or statements contained within this email are for informational purposes only and do not represent a commitment, promise, or legal obligation of any kind by Atrenta, Inc. or its affiliates.

[Doxygen-users] @code @endcode with code in between?

[Rene de V. <ren...@ho...>]

Is it possible to do something equivalent to:
/// @codex = x +1... more actual coding here/// @endcode
where the coding in between is not in a comment.
Alternative is there a way to annotate a line of coding, that this should be included in the docu.
Rene. 		 	   		  

[Doxygen-users] How to force extraction of only specific private class members?

[Arvind P. <arv...@gm...>]

Hi,
I want Doxygen to force extraction of only specific private class members.
I know about the
EXTRACT_PRIVATE<http://www.stack.nl/%7Edimitri/doxygen/manual/config.html#cfg_extract_private>option,
but it extracts
*all* private members. I want to be able to pick and choose which private
members I want to be extracted.

For example something like the following:

class Foo {private:
  /** @forceextract
    * @brief Something about this function.
    */
  void foo1();

  /** @brief Something about this other function.
    */
  void foo2();};

foo1()'s documentation should be extracted though it is private, but
foo2()should be left alone. Is it possible to do this?

Note: Also asked this question on SO
here<http://stackoverflow.com/q/19852936/252576>(
http://stackoverflow.com/q/19852936/252576)

Regards,
Arvind Pai

Re: [Doxygen-users] \copydoc warning - target of \copydoc command not found

[didje <dia...@pd...>]

I discovered the solution to this problem.
I set following properties in the doxyfile to YES and, hey presto, copydoc
statements found the inner classes:

EXTRACT_ALL           = YES
EXTRACT_PRIVATE       = YES
EXTRACT_STATIC        = YES

I think EXTRACT_STATIC was not necessary to fix this, but I needed it for
another (unrelated) reason.





--
View this message in context: http://doxygen.10944.n7.nabble.com/copydoc-warning-target-of-copydoc-command-not-found-tp6345p6356.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

[Doxygen-users] abstract class (struct) not documented when Q_SIGNALS: is used inside it

[Philipp K. <phi...@gm...>]

Given this struct in a .h file:

/**
  Shows an application introduction to the user.
*/
struct WelcomeExperience {
  virtual ~WelcomeExperience() {}
  /**
    Displays the welcome window on the screen.
  */
  virtual void show() = 0;
Q_SIGNALS:
  /**
    This signal is emitted when the user finished the welcome experience or
canceled it.
  */
  void done();
};

No documentation is generated for it, unless I remove the Q_SIGNALS part.
I am using doxygen 1.8.5

Re: [Doxygen-users] \copydoc warning - target of \copydoc command not found

[didje <dia...@pd...>]

Here is an exchange of mails I had on the above problem, which did not
unfortunately, resolve it:

Hi Arthur
I tried removing the outer class specification, but unfortunately that did
not work, as you thought.
Well, that's not quite true - bizarrely it worked for a method with a return
type of void...but not for the other methods, don't ask me why...
Diarmuid

Hi Diarmuid;

Nope. Don't think that there is anything wrong with the statement and the
return argument (seems to) have no relevancy. Can't say that I've helped
much but here is a copydoc from my code. Seems about the same as yours
except that I'm not referencing an inner class. I suppose that you might
want to remove the outer class specification and see if that improves
things, but I don't think that that should work.


    /** @copydoc SlipCellBase::remove() */

art

Hi Arthur,
Thanks for your reply.
No, I did not mean class testClassX : innerClassX.
The example I gave is direct from the code.
testClassX is not a namespace, it is a class. It is declared in a .h file.
The code I supplied is from the corresponding .cpp file.
Diarmuid

Did you mean "class testClassX : innerClassX {"? Where is the namespace
testClassX defined?

art




--
View this message in context: http://doxygen.10944.n7.nabble.com/copydoc-warning-target-of-copydoc-command-not-found-tp6345p6352.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

Re: [Doxygen-users] C++ cast operator, 1.8.4 to 1.8.5 changes and maybe a feature request

[liam m. <lia...@go...>]

On 2 November 2013 14:30, liam mail <lia...@go...> wrote:

> Couple of questions:
> - How can you reference a cast operator which is a member function of a
> C++ class?
> - Has there been changes in how parameters are handled between 1.8.4 and
> 1.8.5? I could not see anything in the changelog about this. In 1.8.4 I was
> using Doxygen to document Lua code as if it was a build in language, this
> required a few changes just for docs although it did work. For a Lua
> functions documented as the following it produced correct parameter details
>         \fn function gen(options, path)
>         \param options [optional] Defaults to the library \ref defaults
>         \param path [optional] Defaults to the current working directory
>         \brief Generate boilerplate header files
>         \details Generates boilerplate C++ files code required for OOLua
> using the passed options
>         or if an option is not present then the default is used. If Path
> is not nil then it is
>         required to be a string which is slash postfixed.
> Yet in 1.8.5 it no longer generates correct parameter documentation,
> instead it places the param documentation verbatim. I have tried removing
> [optional] to see if that was the problem, yet it had no effect.
> - Is there an keyword I can use so that the library does not warn about
> something Doxygen finds at a specific location? I am abusing the library
> documenting macros which take __VA_ARGS__ as if they take named parameters
> and the output is cluttered with warnings, which makes it difficult to pick
> out genuine problems. I could write a script to strip some of these from
> the log but it would be nice if there was some keyword for this, in a
> similar manner to //NOLINT.
>
> Thanks
> --Liam
>


Sorry I should have provided this information.
Whilst the version is reported as 1.8.5 the code is pulled from the github
repo and I have seen the stackoverflow question and bug report [1]
The Lua code which is being documented can be seen in its entirety at [2]
and an example of the macro __VA_ARGS__ abuse can be seen at [3].


[1] https://bugzilla.gnome.org/show_bug.cgi?id=707431
[2]
https://bitbucket.org/liamdevine/oolua/src/a736895db8e87058f7c4376aae20f17187bd993d/build_scripts/oolua_generate.lua?at=OOLua-2
[3]
https://bitbucket.org/liamdevine/oolua/src/c29b03fc3a3bb5f6497b1c20d5cb84ffe31feb9e/include/dsl_va_args.h?at=OOLua-2#cl-258

Thanks
--Liam

[Doxygen-users] C++ cast operator, 1.8.4 to 1.8.5 changes and maybe a feature request

[liam m. <lia...@go...>]

Couple of questions:
- How can you reference a cast operator which is a member function of a C++
class?
- Has there been changes in how parameters are handled between 1.8.4 and
1.8.5? I could not see anything in the changelog about this. In 1.8.4 I was
using Doxygen to document Lua code as if it was a build in language, this
required a few changes just for docs although it did work. For a Lua
functions documented as the following it produced correct parameter details
        \fn function gen(options, path)
        \param options [optional] Defaults to the library \ref defaults
        \param path [optional] Defaults to the current working directory
        \brief Generate boilerplate header files
        \details Generates boilerplate C++ files code required for OOLua
using the passed options
        or if an option is not present then the default is used. If Path is
not nil then it is
        required to be a string which is slash postfixed.
Yet in 1.8.5 it no longer generates correct parameter documentation,
instead it places the param documentation verbatim. I have tried removing
[optional] to see if that was the problem, yet it had no effect.
- Is there an keyword I can use so that the library does not warn about
something Doxygen finds at a specific location? I am abusing the library
documenting macros which take __VA_ARGS__ as if they take named parameters
and the output is cluttered with warnings, which makes it difficult to pick
out genuine problems. I could write a script to strip some of these from
the log but it would be nice if there was some keyword for this, in a
similar manner to //NOLINT.

Thanks
--Liam

Re: [Doxygen-users] Segmentation fault while parsing a C file

[Dimitri v. H. <do...@gm...>]

Hi Artem,

I just checked with the latest doxygen build and it still crashes, so please
file a bug report.

Regards,
  Dimitri

On Oct 26, 2013, at 10:21 , Artem Shinkarov <art...@gm...> wrote:

> Dear doxygen users
> 
> I came across a segmentation fault while doxygen is trying to parse a C
> file.  The C file is attached.  In essence, the line that triggers the
> fault (as it seems) is:
> 
> /**<!--***************************************************************-->
> 
> if one replaces that with
> 
> /** <!--***************************************************************-->
> 
> the problem goes away.
> 
> I do understand that the latter variant is preferred and is expected by
> doxygen, but producing segfault on such an example seem to bee too
> harsh.
> 
> I am using 1.8.4 version of doxygen.
> 
> Now, should I report a bug, or is it a well-known problem?
> 
> 
> 
> Thanks,
> Artem.
> <foo.c>------------------------------------------------------------------------------
> October Webinars: Code for Performance
> Free Intel webinars can help you accelerate application performance.
> Explore tips for MPI, OpenMP, advanced profiling, and more. Get the most from 
> the latest Intel processors and coprocessors. See abstracts and register >
> http://pubads.g.doubleclick.net/gampad/clk?id=60135991&iu=/4140/ostg.clktrk_______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users

[Doxygen-users] Segmentation fault while parsing a C file

[Artem S. <art...@gm...>]

Dear doxygen users

I came across a segmentation fault while doxygen is trying to parse a C
file.  The C file is attached.  In essence, the line that triggers the
fault (as it seems) is:

/**<!--***************************************************************-->

if one replaces that with

/** <!--***************************************************************-->

the problem goes away.

I do understand that the latter variant is preferred and is expected by
doxygen, but producing segfault on such an example seem to bee too
harsh.

I am using 1.8.4 version of doxygen.

Now, should I report a bug, or is it a well-known problem?



Thanks,
Artem.