doxygen-users — List for users of doxygen

Re: [Doxygen-users] RTF output has incomplete "References" and "Referenced by" sections

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

Based on the message in bugzilla:

I've just pushed a proposed solution to github (pull request 400).



On Mon, Sep 28, 2015 at 10:28 AM, Ingolf Steinbach <
ing...@gm...> wrote:

> Hi again,
>
> Please find attached a small example showing the problem (look at the
> description of the trunk() function in the RTF output). Note that the
> strange behavior seems to be independent from the COMPACT_RTF setting.
>
> Kind regards
> Ingolf
>
> PS: My first attempt to submit an example was rejected because the
> example was contained in a ZIP file. Let's see whether TAR is accepted
> by sourceforge...
>
>
> ------------------------------------------------------------------------------
>
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>

Re: [Doxygen-users] It seems Doxygen get confuse when using

[Olivier C. <Oli...@ce...>]

Any idea about this one ?


On 28 Sep 2015, at 08:28, Olivier Couet <oli...@ce...<mailto:oli...@ce...>> wrote:

Hi,

We have a C++ class called: TFile

The C++ source file is in: /roottrunk/io/io/src/TFile.cxx
The header is in :              /roottrunk/io/io/inc/TFile.h

We have also an extra  TFile.h in: /roottrunk/io/io/v7/inc/ROOT/TFile.h


STRIP_FROM_INC_PATH is left blank (in Doxyfile), we get the following lines a the end of the file classTFile.html
generated by doxygen:

------
The documentation for this class was generated from the following files:

  *   io/io/inc/TFile.h<file:///Users/couet/rootdoc/html/inc_2TFile_8h_source.html>
  *   io/io/src/TFile.cxx<file:///Users/couet/rootdoc/html/src_2TFile_8cxx_source.html>

------

If instead we put the following paths in STRIP_FROM_INC_PATH (in Doxyfile)

/roottrunk/io/io/inc
/roottrunk/io/io/v7/inc

we get the following lines a the end of the file classTFile.html generated by doxygen

------
The documentation for this class was generated from the following files:

  *   io/io/v7/inc/ROOT/TFile.h<file:///Users/couet/rootdoc/html/v7_2inc_2ROOT_2TFile_8h_source.html>
  *   io/io/src/TFile.cxx<file:///Users/couet/rootdoc/html/src_2TFile_8cxx_source.html>

------

so it seems doxygen gets confused and pick the wrong include file.

Can you explain ?

Cheers, Olivier
------------------------------------------------------------------------------
_______________________________________________
Doxygen-users mailing list
Dox...@li...<mailto:Dox...@li...>
https://lists.sourceforge.net/lists/listinfo/doxygen-users

Re: [Doxygen-users] MD5 Hash of C++ methods?

[woody <kn...@re...>]

At 06:05 PM 9/28/2015 +0200, Jari Williamsson wrote:
>Damon,
>
>Thanks for your suggestion! In my case, it's over 300 classes and 8,000
>methods, so auto-detection of the MD5 hash anchor would be preferred.
>But if I can't find out the MD5 hash generation text, I'll probably
>create a parser of the source code to autogenerate @anchors instead.

That would be interesting software to have the source for.  Essentially 
that would have to be a full parser for C++ ?
autogeneration of comments etc is something that is sorely needed for 
documenting cold code.




>Best regards,
>
>Jari Williamsson
>
>
>
>On 2015-09-28 17:50, dam...@xc... wrote:
> > Hello Jari
> >
> > I don't know if you need to get a lot of these. I avoid this problem by
> > adding @anchor explicitly, so I can name it what I want. I hope that helps.
> >
> > - Damon
> >
> > Inactive hide details for Jari Williamsson ---09/28/2015 11:46:50
> > AM---Dear List, I'm trying to programmatically bring up the HJari
> > Williamsson ---09/28/2015 11:46:50 AM---Dear List, I'm trying to
> > programmatically bring up the HTML documentation for a C++
> >
> >
> >     From:
> >
> >
> > Jari Williamsson <jar...@ma...>
> >
> >     To:
> >
> >
> > dox...@li...,
> >
> >     Date:
> >
> >
> > 09/28/2015 11:46 AM
> >
> >     Subject:
> >
> >
> > [Doxygen-users] MD5 Hash of C++ methods?
> >
> > ------------------------------------------------------------------------
> >
> >
> >
> > Dear List,
> >
> > I'm trying to programmatically bring up the HTML documentation for a C++
> > method, using the MD5 hash anchor for the method. (I have no problem
> > finding the correct HTML file, since the class "MyClass" simply becomes
> > "class_my_class.html".)
> >
> > However, I have trouble founding out the text that is used to becomes
> > the MD5 anchor for the method.
> >
> > So, if I have a method in "MyClass" declared as...
> > int MyMethod() const;
> > ...what is the text that will be used to construct the MD5 hash anchor
> > for the method in the HTML file?
> >
> > Thanks in advance!
> >
> >
> > Best regards,
> >
> > Jari Williamsson
> >
> >
> > 
> ------------------------------------------------------------------------------
> > _______________________________________________
> > Doxygen-users mailing list
> > Dox...@li...
> > 
> http://cp.mcafee.com/d/avndxMO71MQrhoopovvjKYrKrhKyevphsuKrhKMUej76zBNUSzt4s-OyUYyrhK_tYsYO_sSxGJotroP-8a3Xv6eYKr3Xv6eYKr7vtMQsTsvW_8CzAQsLfTsWZOWqqr7cCzBV5ZdPBHEShhlhKDOEuvkzaT0QSyrhdTV4QsCzB5N6UVdYTsSjDdqymovaAWtiHsruW01_wrxYGjFxYGjB1SK8l3ON7U5SWv6xJ2Eum8_0KTjUQbAaJMJZ0kvaAWtiHsruW01_wqropspdCBIeG7ByfMbJQ-d3iWq81Ievd40nSxcQgltd40A0409Ewl-peG52hJyVJVwmQ3rk56Y0
> >
> >
>
>
>
>------------------------------------------------------------------------------
>_______________________________________________
>Doxygen-users mailing list
>Dox...@li...
>https://lists.sourceforge.net/lists/listinfo/doxygen-users

Re: [Doxygen-users] MD5 Hash of C++ methods?

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

Hi Jari,

Although you could look at MemberDef::setAnchor() to see what is used, I think it
is better to generate a tag file, and parse that to get the mapping from names to anchors.
See GENERATE_TAGFILE. A tag file is an XML file with pretty straightforward contents.

Regards,
  Dimitri

> On 28 Sep 2015, at 18:05 , Jari Williamsson <jar...@ma...> wrote:
> 
> Damon,
> 
> Thanks for your suggestion! In my case, it's over 300 classes and 8,000 
> methods, so auto-detection of the MD5 hash anchor would be preferred. 
> But if I can't find out the MD5 hash generation text, I'll probably 
> create a parser of the source code to autogenerate @anchors instead.
> 
> 
> Best regards,
> 
> Jari Williamsson
> 
> 
> 
> On 2015-09-28 17:50, dam...@xc... wrote:
>> Hello Jari
>> 
>> I don't know if you need to get a lot of these. I avoid this problem by
>> adding @anchor explicitly, so I can name it what I want. I hope that helps.
>> 
>> - Damon
>> 
>> Inactive hide details for Jari Williamsson ---09/28/2015 11:46:50
>> AM---Dear List, I'm trying to programmatically bring up the HJari
>> Williamsson ---09/28/2015 11:46:50 AM---Dear List, I'm trying to
>> programmatically bring up the HTML documentation for a C++
>> 
>> 
>>    From:
>> 
>> 	
>> Jari Williamsson <jar...@ma...>
>> 
>>    To:
>> 
>> 	
>> dox...@li...,
>> 
>>    Date:
>> 
>> 	
>> 09/28/2015 11:46 AM
>> 
>>    Subject:
>> 
>> 	
>> [Doxygen-users] MD5 Hash of C++ methods?
>> 
>> ------------------------------------------------------------------------
>> 
>> 
>> 
>> Dear List,
>> 
>> I'm trying to programmatically bring up the HTML documentation for a C++
>> method, using the MD5 hash anchor for the method. (I have no problem
>> finding the correct HTML file, since the class "MyClass" simply becomes
>> "class_my_class.html".)
>> 
>> However, I have trouble founding out the text that is used to becomes
>> the MD5 anchor for the method.
>> 
>> So, if I have a method in "MyClass" declared as...
>> int MyMethod() const;
>> ...what is the text that will be used to construct the MD5 hash anchor
>> for the method in the HTML file?
>> 
>> Thanks in advance!
>> 
>> 
>> Best regards,
>> 
>> Jari Williamsson
>> 

Re: [Doxygen-users] MD5 Hash of C++ methods?

[<dam...@xc...>]

Hello Jari

I don't know if you need to get a lot of these. I avoid this problem by
adding @anchor explicitly, so I can name it what I want. I hope that helps.

- Damon


                                                                                                                      
  From:       Jari Williamsson <jar...@ma...>                                                  
                                                                                                                      
  To:         dox...@li...,                                                                    
                                                                                                                      
  Date:       09/28/2015 11:46 AM                                                                                     
                                                                                                                      
  Subject:    [Doxygen-users] MD5 Hash of C++ methods?                                                                
                                                                                                                      





Dear List,

I'm trying to programmatically bring up the HTML documentation for a C++
method, using the MD5 hash anchor for the method. (I have no problem
finding the correct HTML file, since the class "MyClass" simply becomes
"class_my_class.html".)

However, I have trouble founding out the text that is used to becomes
the MD5 anchor for the method.

So, if I have a method in "MyClass" declared as...
int MyMethod() const;
...what is the text that will be used to construct the MD5 hash anchor
for the method in the HTML file?

Thanks in advance!


Best regards,

Jari Williamsson


------------------------------------------------------------------------------

_______________________________________________
Doxygen-users mailing list
Dox...@li...
http://cp.mcafee.com/d/avndxMO71MQrhoopovvjKYrKrhKyevphsuKrhKMUej76zBNUSzt4s-OyUYyrhK_tYsYO_sSxGJotroP-8a3Xv6eYKr3Xv6eYKr7vtMQsTsvW_8CzAQsLfTsWZOWqqr7cCzBV5ZdPBHEShhlhKDOEuvkzaT0QSyrhdTV4QsCzB5N6UVdYTsSjDdqymovaAWtiHsruW01_wrxYGjFxYGjB1SK8l3ON7U5SWv6xJ2Eum8_0KTjUQbAaJMJZ0kvaAWtiHsruW01_wqropspdCBIeG7ByfMbJQ-d3iWq81Ievd40nSxcQgltd40A0409Ewl-peG52hJyVJVwmQ3rk56Y0

Re: [Doxygen-users] MD5 Hash of C++ methods?

[Jari W. <jar...@ma...>]

Damon,

Thanks for your suggestion! In my case, it's over 300 classes and 8,000 
methods, so auto-detection of the MD5 hash anchor would be preferred. 
But if I can't find out the MD5 hash generation text, I'll probably 
create a parser of the source code to autogenerate @anchors instead.


Best regards,

Jari Williamsson



On 2015-09-28 17:50, dam...@xc... wrote:
> Hello Jari
>
> I don't know if you need to get a lot of these. I avoid this problem by
> adding @anchor explicitly, so I can name it what I want. I hope that helps.
>
> - Damon
>
> Inactive hide details for Jari Williamsson ---09/28/2015 11:46:50
> AM---Dear List, I'm trying to programmatically bring up the HJari
> Williamsson ---09/28/2015 11:46:50 AM---Dear List, I'm trying to
> programmatically bring up the HTML documentation for a C++
>
>
>     From:
>
> 	
> Jari Williamsson <jar...@ma...>
>
>     To:
>
> 	
> dox...@li...,
>
>     Date:
>
> 	
> 09/28/2015 11:46 AM
>
>     Subject:
>
> 	
> [Doxygen-users] MD5 Hash of C++ methods?
>
> ------------------------------------------------------------------------
>
>
>
> Dear List,
>
> I'm trying to programmatically bring up the HTML documentation for a C++
> method, using the MD5 hash anchor for the method. (I have no problem
> finding the correct HTML file, since the class "MyClass" simply becomes
> "class_my_class.html".)
>
> However, I have trouble founding out the text that is used to becomes
> the MD5 anchor for the method.
>
> So, if I have a method in "MyClass" declared as...
> int MyMethod() const;
> ...what is the text that will be used to construct the MD5 hash anchor
> for the method in the HTML file?
>
> Thanks in advance!
>
>
> Best regards,
>
> Jari Williamsson
>
>
> ------------------------------------------------------------------------------
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> http://cp.mcafee.com/d/avndxMO71MQrhoopovvjKYrKrhKyevphsuKrhKMUej76zBNUSzt4s-OyUYyrhK_tYsYO_sSxGJotroP-8a3Xv6eYKr3Xv6eYKr7vtMQsTsvW_8CzAQsLfTsWZOWqqr7cCzBV5ZdPBHEShhlhKDOEuvkzaT0QSyrhdTV4QsCzB5N6UVdYTsSjDdqymovaAWtiHsruW01_wrxYGjFxYGjB1SK8l3ON7U5SWv6xJ2Eum8_0KTjUQbAaJMJZ0kvaAWtiHsruW01_wqropspdCBIeG7ByfMbJQ-d3iWq81Ievd40nSxcQgltd40A0409Ewl-peG52hJyVJVwmQ3rk56Y0
>
>

[Doxygen-users] MD5 Hash of C++ methods?

[Jari W. <jar...@ma...>]

Dear List,

I'm trying to programmatically bring up the HTML documentation for a C++ 
method, using the MD5 hash anchor for the method. (I have no problem 
finding the correct HTML file, since the class "MyClass" simply becomes 
"class_my_class.html".)

However, I have trouble founding out the text that is used to becomes 
the MD5 anchor for the method.

So, if I have a method in "MyClass" declared as...
int MyMethod() const;
...what is the text that will be used to construct the MD5 hash anchor 
for the method in the HTML file?

Thanks in advance!


Best regards,

Jari Williamsson

Re: [Doxygen-users] RTF output has incomplete "References" and "Referenced by" sections

[Ingolf S. <ing...@gm...>]

Hi again,

Please find attached a small example showing the problem (look at the
description of the trunk() function in the RTF output). Note that the
strange behavior seems to be independent from the COMPACT_RTF setting.

Kind regards
Ingolf

PS: My first attempt to submit an example was rejected because the
example was contained in a ZIP file. Let's see whether TAR is accepted
by sourceforge...

[Doxygen-users] It seems Doxygen get confuse when using

[Olivier C. <Oli...@ce...>]

Hi,

We have a C++ class called: TFile

The C++ source file is in: /roottrunk/io/io/src/TFile.cxx
The header is in :              /roottrunk/io/io/inc/TFile.h

We have also an extra  TFile.h in: /roottrunk/io/io/v7/inc/ROOT/TFile.h


STRIP_FROM_INC_PATH is left blank (in Doxyfile), we get the following lines a the end of the file classTFile.html
generated by doxygen:

------
The documentation for this class was generated from the following files:

  *   io/io/inc/TFile.h<file:///Users/couet/rootdoc/html/inc_2TFile_8h_source.html>
  *   io/io/src/TFile.cxx<file:///Users/couet/rootdoc/html/src_2TFile_8cxx_source.html>

------

If instead we put the following paths in STRIP_FROM_INC_PATH (in Doxyfile)

/roottrunk/io/io/inc
/roottrunk/io/io/v7/inc

we get the following lines a the end of the file classTFile.html generated by doxygen

------
The documentation for this class was generated from the following files:

  *   io/io/v7/inc/ROOT/TFile.h<file:///Users/couet/rootdoc/html/v7_2inc_2ROOT_2TFile_8h_source.html>
  *   io/io/src/TFile.cxx<file:///Users/couet/rootdoc/html/src_2TFile_8cxx_source.html>

------

so it seems doxygen gets confused and pick the wrong include file.

Can you explain ?

Cheers, Olivier

Re: [Doxygen-users] any workaround - to get a function into multiple groups ?

[Monique S. <mon...@ea...>]

> However, my alternate approach would be provide extra groups for the common functions:

Yes, that’s what I ended up doing. But it’s still not so user friendly because now users have to look at multiple groups to see all the functions for, say, async client (async client, core (aync and sycn) client, shared (client and server) async, and core (async and sync) shared (client and server)) instead of being able to look at just one group. But I added all the others as @sa references to help guide readers.

So this makes it even more important to include good example code to point people to the relevant functions in a way that’s not dependent on the groups.

Thanks for the confirmation that it’s a reasonable approach,
-Monique

[Doxygen-users] Doxyfile license?

[Ryan B. <bl...@cl...>]

Hi everyone,

I'm trying to find out what the license is for the Doxygen-generated 
Doxyfile. I have a project that uses Doxygen and is licensed with ASL 
2.0. I'm concerned that because the source used to generate the Doxyfile 
[1] is GPL, that it is GPL-licensed and can't be included in an ASL project.

I think that's probably not intended, so I'm hoping to get clarification 
on what the license for a Doxyfile is.

I also opened an issue for this here:

   https://bugzilla.gnome.org/show_bug.cgi?id=755135

Thanks for your help,

rb

[1]: https://github.com/doxygen/doxygen/blob/master/src/config.xml

-- 
Ryan Blue

Re: [Doxygen-users] any workaround - to get a function into multiple groups ?

[Ron W <ron...@gm...>]

On Fri, Sep 25, 2015 at 9:18 AM, <
dox...@li...> wrote:
>
> Date: Wed, 23 Sep 2015 16:59:13 -0700
> From: "Monique Semp" <mon...@ea...>
> Subject: [Doxygen-users] any workaround - to get a function into
>         multiple        groups ?
>
> And definitely, from the user-perspective, it?s very logical to have a
> function that ?belongs? in multiple groups. For example, I have some
> communications functions for async client, sync client, async server, and
> sync server. And so I have these four groups. But for example, some
> functions apply to both the sync client and the sync server, and so I
> certainly want to include the functions in both groups.
>

I don't know of a way to do this short of pre and post processing.

However, my alternate approach would be provide extra groups for the common
functions:

        * Common
        * Client
            * Common
            * Async
            * Sync
        * Server
            * Common
            * Async
            * Sync

Or what ever hierarchy makes sense for your project.

[Doxygen-users] RTF output has incomplete "References" and "Referenced by" sections

[Ingolf S. <ing...@gm...>]

Hi,

when generating RTF output with doxygen 1.8.10 (linux, x86_64), the
resulting refman.rtf does not show the "References" and "Referenced
by" sections correctly: it contains these headings and also separators
like comma but the actual names of the functions are omitted.

Example:

> Returns:
> This function returns the number of bytes actually copied.
> Definition at line 19 of file some_file.c.
> References .
> Referenced by , , and .
> Here is the call graph for this function:

The HTML output generated from the same input files shows the two
sections correctly:

> Returns
>   This function returns the number of bytes actually copied.
> Definition at line 19 of file some_file.c.
> References foobar().
> Referenced by check_(), copy_(), and readChunk_().

The documentation for all of foobar(), check_(), copy_(), and
readChunk_() is contained in the refman.rtf document -- together with
anchors for the hyperlinks.

Is this expected behavior? A bug? Am I missing something?


The configuration for RTF is as follows:
GENERATE_RTF           = YES
RTF_OUTPUT             = rtf
COMPACT_RTF            = NO
RTF_HYPERLINKS         = YES
RTF_STYLESHEET_FILE    =
RTF_EXTENSIONS_FILE    =
RTF_SOURCE_CODE        = NO


Kind regards
Ingolf

[Doxygen-users] any workaround - to get a function into multiple groups ?

[Monique S. <mon...@ea...>]

Hello, Doxygen users,

I doubt it, but does anyone have any workarounds or kludges to get a function into multiple groups (for Doxygen 1.8.10, C code)?

I know that the Doxygen documentation for Grouping, https://www.stack.nl/~dimitri/doxygen/manual/grouping.html, explicitly says, “Note that compound entities (like classes, files and namespaces) can be put into multiple groups, but members (like variable, functions, typedefs and enums) can only be a member of one group (this restriction is in place to avoid ambiguous linking targets in case a member is not documented in the context of its class, namespace or file, but only visible as part of a group).”

For C code, this restriction seems unnecessary.

And definitely, from the user-perspective, it’s very logical to have a function that “belongs” in multiple groups. For example, I have some communications functions for async client, sync client, async server, and sync server. And so I have these four groups. But for example, some functions apply to both the sync client and the sync server, and so I certainly want to include the functions in both groups.

I could create pages for the groups and then link from each group page to that group’s functions, so I guess that’s one workaround. But I’m hoping (!) that there’s something I could do to have the groups listed in the navigation tree (which I already implemented), and have each group expand to show all the functions in the group, with some functions appearing in more than one group.

Thanks very much,
-Monique

Re: [Doxygen-users] Doxygen and check style issue

[Richard D. <Ri...@Da...>]

On 9/23/15 1:38 AM, sai mrithyunjaya wrote:
>
> Hi,
>
> We are facing an issue with the below code i.e doxygen warning.
>
> /**
>
>      * Check combo box selections by user.
>
>      * *@param* cmb javafx.scene.control.ComboBox
>
>      * *@param* failMsg Error message
>
>      * *@param* <T> This is the type parameter
>
>      * *@return* Returns True javafx.scene.control.ComboBox is Valid 
> one otherwise False
>
>      */
>
> *private* *static*<T> Boolean checkComboSelection(*final* ComboBox<T> 
> cmb, *final* String failMsg) {
>
>      }
>
> 1) In the line * *@param* <T> This is the type parameter a doxygen 
> warning is thrown “*warning: argument 'T' of command @param is not 
> found in the argument list of com.abc.xyz::checkComboSelection(final 
> **ComboBox**< T > **cmb**, final String **failMsg**)”*
>
> 2) But when we replace <T> with *checkComboSelection *then we are 
> getting a *checkStyle* warning* “Unused @param tag for 
> 'checkComboSelection'.”*
>
> * *@**param* *checkComboSelection***This is the type parameter
>
> **In case "1" it is a doxygen warning and
> In case "2" it is a check style warning.
>
> Is there another way to write doxygen comment for that parameter?
>
> Could anyone please help us fix this issue.
>
>
> Thank you
> Sai
>
The issue is that <T> is not a parameter of the function, so @param is 
complaining. I think you want @tparam instead.

-- 
Richard Damon

[Doxygen-users] Doxygen and check style issue

[sai m. <ts...@gm...>]

Hi,

We are facing an issue with the below code i.e doxygen warning.

/**

     * Check combo box selections by user.

     * *@param* cmb javafx.scene.control.ComboBox

     * *@param* failMsg Error message

     * *@param* <T> This is the type parameter

     * *@return* Returns True javafx.scene.control.ComboBox is Valid one
otherwise False

     */

    *private* *static*<T> Boolean checkComboSelection(*final* ComboBox<T>
cmb, *final* String failMsg) {

     }

1) In the line * *@param* <T> This is the type parameter a doxygen warning
is thrown “*warning: argument 'T' of command @param is not found in the
argument list of com.abc.xyz::checkComboSelection(final **ComboBox**< T > *
*cmb**, final String **failMsg**)”*



2) But when we replace <T> with *checkComboSelection *then we are getting a
*checkStyle* warning* “Unused @param tag for 'checkComboSelection'.”*

* *@**param* *checkComboSelection* This is the type parameter

 In case "1" it is a doxygen warning and
In case "2" it is a check style warning.

Is there another way to write doxygen comment for that parameter?

Could anyone please help us fix this issue.


Thank you
Sai

Re: [Doxygen-users] now want to suppress \brief in \page display

[Monique S. <mon...@ea...>]

I’m guessing that to do what I’m wishing, I’d have to go the XML route, as the manual describes: http://www.stack.nl/~dimitri/doxygen/manual/customize.html#xmlgenerator. My wish is pretty small, though, and certainly too small to justify a big effort to customize XML parsing.

But perhaps there is a simpler way?

-Monique


From: Monique Semp 
Sent: Monday, September 21, 2015 8:48 AM
To: Albert 
Cc: doxygen-users 
Subject: Re: [Doxygen-users] now want to suppress \brief in \page display

Oh, and I did try setting the <briefdescription> element’s “visible” attribute to “no” for the <file> layout, and the supposition that perhaps the file page layout might also apply to any page that’s created by the \page command, but it had no apparent effect.

From: Monique Semp 
Sent: Monday, September 21, 2015 8:36 AM
To: Albert 
Cc: doxygen-users 
Subject: Re: [Doxygen-users] now want to suppress \brief in \page display

> Did you have a look at the possibilities of the doxygen layout file? (doxygen -l and the LAYOUT_FILE setting in the Doxyfile)


Hi Albert,

I took a look, but none of the existing layouts seem applicable. There are layout definitions for the following types of pages: class, namespace, file, group, and directory. But nothing for a “page” page.

Nonetheless, I tried creating a new element, <pages> (because this is the value of “type” for one of the <tab> elements in the <navindex>), at the same level as <directory>, with all the same values except for setting the <briefdescription> element’s “visible” attribute value to “no”. But then when I run doxygen with this layout file (via the doxywizard), I get error like this:

“Unexpected start tag ‘page’ found in scope=’(null)’!

So the layout of a \page page file seems to be controlled by some other mechanism?

I’m wondering what other approach I might try?

-Monique

Re: [Doxygen-users] now want to suppress \brief in \page display

[Monique S. <mon...@ea...>]

Oh, and I did try setting the <briefdescription> element’s “visible” attribute to “no” for the <file> layout, and the supposition that perhaps the file page layout might also apply to any page that’s created by the \page command, but it had no apparent effect.

From: Monique Semp 
Sent: Monday, September 21, 2015 8:36 AM
To: Albert 
Cc: doxygen-users 
Subject: Re: [Doxygen-users] now want to suppress \brief in \page display

> Did you have a look at the possibilities of the doxygen layout file? (doxygen -l and the LAYOUT_FILE setting in the Doxyfile)


Hi Albert,

I took a look, but none of the existing layouts seem applicable. There are layout definitions for the following types of pages: class, namespace, file, group, and directory. But nothing for a “page” page.

Nonetheless, I tried creating a new element, <pages> (because this is the value of “type” for one of the <tab> elements in the <navindex>), at the same level as <directory>, with all the same values except for setting the <briefdescription> element’s “visible” attribute value to “no”. But then when I run doxygen with this layout file (via the doxywizard), I get error like this:

“Unexpected start tag ‘page’ found in scope=’(null)’!

So the layout of a \page page file seems to be controlled by some other mechanism?

I’m wondering what other approach I might try?

-Monique

Re: [Doxygen-users] now want to suppress \brief in \page display

[Monique S. <mon...@ea...>]

> Did you have a look at the possibilities of the doxygen layout file? (doxygen -l and the LAYOUT_FILE setting in the Doxyfile)


Hi Albert,

I took a look, but none of the existing layouts seem applicable. There are layout definitions for the following types of pages: class, namespace, file, group, and directory. But nothing for a “page” page.

Nonetheless, I tried creating a new element, <pages> (because this is the value of “type” for one of the <tab> elements in the <navindex>), at the same level as <directory>, with all the same values except for setting the <briefdescription> element’s “visible” attribute value to “no”. But then when I run doxygen with this layout file (via the doxywizard), I get error like this:

“Unexpected start tag ‘page’ found in scope=’(null)’!

So the layout of a \page page file seems to be controlled by some other mechanism?

I’m wondering what other approach I might try?

-Monique

Re: [Doxygen-users] now want to suppress \brief in \page display

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

Monique,

Did you have a look at the possibilities of the doxygen layout file?
(doxygen -l and the LAYOUT_FILE setting in the Doxyfile)

Albert

On Sat, Sep 19, 2015 at 2:17 AM, Monique Semp <mon...@ea...>
wrote:

> (Using Doxygen 1.8.10)
>
> Well, setting the REPEAT_BRIEF option to NO took care of the earlier
> problem (below), but now I find the same issue with .page files.
>
> The \brief description nicely appears in the table/list in the Related
> Pages, but unfortunately it also appears in the page itself.
>
> So apparently the REPEAT_BRIEF setting does not apply to documentation for
> \page content.
>
> Is this as intended, a bug, something that is configurable, or maybe just
> something that hasn’t come up yet?
>
> Thanks for any suggestions,
> -Monique
>
>
> *From:* Monique Semp <mon...@ea...>
> *Sent:* Tuesday, September 15, 2015 5:55 PM
> *To:* doxygen-users <dox...@li...>
> *Subject:* any way to suppress - prepending \brief to \details in class &
> file members ?
>
> Hello, Doxygen users,
>
> I’m wondering if there’s any way to suppress the standard behavior of the
> \brief and \details commands for class & file members? As it says in the
> documentation,
> https://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdbrief, the
> \brief is prepended to the \details.
>
> But I really, really wish that when there is a \details command, only it
> would appear in the output (without the prepended \brief content).
>
> <snip>
>
> Thanks for any ideas,
> -Monique
>
>
>
> ------------------------------------------------------------------------------
>
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>

[Doxygen-users] now want to suppress \brief in \page display

[Monique S. <mon...@ea...>]

(Using Doxygen 1.8.10)

Well, setting the REPEAT_BRIEF option to NO took care of the earlier problem (below), but now I find the same issue with .page files.

The \brief description nicely appears in the table/list in the Related Pages, but unfortunately it also appears in the page itself.

So apparently the REPEAT_BRIEF setting does not apply to documentation for \page content.

Is this as intended, a bug, something that is configurable, or maybe just something that hasn’t come up yet?

Thanks for any suggestions,
-Monique


From: Monique Semp 
Sent: Tuesday, September 15, 2015 5:55 PM
To: doxygen-users 
Subject: any way to suppress - prepending \brief to \details in class & file members ?

Hello, Doxygen users,

I’m wondering if there’s any way to suppress the standard behavior of the \brief and \details commands for class & file members? As it says in the documentation, https://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdbrief, the \brief is prepended to the \details.

But I really, really wish that when there is a \details command, only it would appear in the output (without the prepended \brief content).

<snip>

Thanks for any ideas,
-Monique

Re: [Doxygen-users] Hide "Class Hierachy" page?

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

Hi Zack,

Why are you you using "false" and not "no". The default gives "yes" so it
would be logical to use "no".
And from a quick look in the code I think that everything else as "no" or
"0" is considered to be "yes".

Best Regards,

Albert


On Thu, Sep 17, 2015 at 9:44 PM, Zack Snyder <za...@gm...> wrote:

> Hi Albert,
>
> this works, although I have to comment out the section in the layout file
> instead of my first try setting the attribute "visible" to "false".
> However, I would like to add some new custom tab pages to the <navindex>,
> is this possible?
>
> Regards,
> Zack
>
>
>
> On 02.09.2015 09:52, Albert wrote:
>
> Zack,
>
> Please have a look at DoxygenLayout.xml(generated by doxygen -w) and look
> here for "classes"
>
> Alebrt
>
> On Tue, Sep 1, 2015 at 8:45 PM, Zack Snyder <za...@gm...> wrote:
>
>> Hi all,
>>
>> how can I hide the "Class Hierachy" page?
>>
>> Regards,
>> Zack
>>
>>
>> ------------------------------------------------------------------------------
>> _______________________________________________
>> Doxygen-users mailing list
>> Dox...@li...
>> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>>
>
>
>

Re: [Doxygen-users] Hide "Class Hierachy" page?

[Zack S. <za...@gm...>]

Hi Albert,

this works, although I have to comment out the section in the layout 
file instead of my first try setting the attribute "visible" to "false".
However, I would like to add some new custom tab pages to the 
<navindex>, is this possible?

Regards,
Zack


On 02.09.2015 09:52, Albert wrote:
> Zack,
>
> Please have a look at DoxygenLayout.xml(generated by doxygen -w) and 
> look here for "classes"
>
> Alebrt
>
> On Tue, Sep 1, 2015 at 8:45 PM, Zack Snyder <za...@gm... 
> <mailto:za...@gm...>> wrote:
>
>     Hi all,
>
>     how can I hide the "Class Hierachy" page?
>
>     Regards,
>     Zack
>
>     ------------------------------------------------------------------------------
>     _______________________________________________
>     Doxygen-users mailing list
>     Dox...@li...
>     <mailto:Dox...@li...>
>     https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>

[Doxygen-users] Raw class and member extraction for multiple languges

[FallDownT <Fal...@ya...>]

Hello doxygen-users.

Do any of you know of a technique to extract a list of classes and their
respective members (or language equivalent) from source code that will work
for any language using doxygen?  Ultimately I want to extract a list of
classes, member variables, and member functions (or language equivalents)
for my source code in an easy-to-parse format.  An example of this in Java
would be as follows:

*Sample Java Source Code*:
----------------------------------------------
<http://doxygen.10944.n7.nabble.com/file/n7398/hello_world_java.jpg> 
----------------------------------------------
*Desired Parsed Output*:
----------------------------------------------
Package name: com.helloworld
Class name: public class MainClass
Variables:
private int myPrivateInt
private NestedClass myNestedObj
Methods:
public MainClass()
protected void printVars()
public static void main(String[] args)

Package name: com.helloworld
Class name: public class MainClass$NestedClass
Variables:
private float a
Methods:
public NestedClass()
public float getA()

----------------------------------------------

I am aware that doxygen can produce an XML output of the source code, but it
merely tokenizes the code allowing for easier parsing.  To produce the HTML
output on the other hand, doxygen has already parsed the code into all
classes and members, but has also organized them into the HTML documentation
format.  I am looking for an output in the middle of both of these.  I would
like just the raw classes with their accompanying data members.

If anyone knows of a configuration or technique to do this across several
languages using doxygen, please share!

Thanks in advance!



--
View this message in context: http://doxygen.10944.n7.nabble.com/Raw-class-and-member-extraction-for-multiple-languges-tp7398.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

Re: [Doxygen-users] any way to suppress - prepending \brief to \details in class & file members ?

[Monique S. <mon...@ea...>]

> Did you have a look at e.g. BRIEF_MEMBER_DESC and REPEAT_BRIEF in the Doxyfile ?

That’s it! Hats off to Dimitri and the world of programmers who maintain Doxygen! I’m continually impressed with how much has been foreseen and the many options that are available. (Although it is a daunting task to master so many configuration settings.)
And many thanks to Albert and others on this list for constantly helping out novice users.
-Monique