doxygen-users — List for users of doxygen

[Doxygen-users] markdown support for header is messed up in doxygen

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

Hello all,

I have encountered several issue with doxygen and using markdown.
Especially the support for headers (the <hN> tag in HTML).

e.g.:
https://bugzilla.gnome.org/show_bug.cgi?id=744755
https://bugzilla.gnome.org/show_bug.cgi?id=744761

Now I encountered  a problem, where I want to give the main header a 
number in the title
e.g.:

2. My Title  {#my_title_page}
=========

This will result in following HTML rendering

<div class="title h1">
     <ol type="1">
         <li>My Title </li>
     </ol>
</div>

and <title>2. My Title</title>

So in fact it will display wrong:
1. My Title

only the title is correct:
2. My Title
in the title page.

Please I need some workarounds or fixes for all this issues.
Markdown support should be first class, because it is a standard format, 
which will can be reused for other tools too.

Regards,
Zack

Re: [Doxygen-users] styling the PROJECT_NAME output ?

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

Monique,

Nice way is e.g. in Firefox to look with "Inspect Element" which item it is.
In this case it is the class #projectname

Albert

On Wed, Feb 18, 2015 at 5:38 AM, Monique Semp <mon...@ea...>
wrote:

>   Hello, doxygen users,
>
> I’m using Doxygen 1.8.7, and would like to reduce the font size of the
> output for the PROJECT_NAME because it’s a lot of characters, and so takes
> up too much horizontal space.
>
> But I don’t know much CSS, and so I haven’t figured out which class to
> modify in my version of the stylesheet (which I’m specifying as the
> HTML_EXTRA_STYLESHEET config option).
>
> Any ideas?
>
> Thanks,
> -Monique
>
>
> ------------------------------------------------------------------------------
> Download BIRT iHub F-Type - The Free Enterprise-Grade BIRT Server
> from Actuate! Instantly Supercharge Your Business Reports and Dashboards
> with Interactivity, Sharing, Native Excel Exports, App Integration & more
> Get technology previously reserved for billion-dollar corporations, FREE
>
> http://pubads.g.doubleclick.net/gampad/clk?id=190641631&iu=/4140/ostg.clktrk
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>

[Doxygen-users] styling the PROJECT_NAME output ?

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

Hello, doxygen users,

I’m using Doxygen 1.8.7, and would like to reduce the font size of the output for the PROJECT_NAME because it’s a lot of characters, and so takes up too much horizontal space.

But I don’t know much CSS, and so I haven’t figured out which class to modify in my version of the stylesheet (which I’m specifying as the HTML_EXTRA_STYLESHEET config option).

Any ideas?

Thanks,
-Monique

Re: [Doxygen-users] how to rename the "Modules" group ?

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

> I guess, you can use the layouts file to specify a different title. See 
> [1] for
the docs on that. First generate the default layouts file and right in the 
first
section edit the corresponding 'title' attribute. E.g.:

>>     <tab type="modules" visible="yes" title="Entities" intro=""/>

>> [1]: http://www.stack.nl/~dimitri/doxygen/manual/customize.html#layout

Yes, that was easy and it worked!
Thank you very much,
-Monique

[Doxygen-users] how to rename the "Modules" group ?

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

1. I’m using Doxygen 1.8.7, and am wondering how I can rename the “Modules” group, which for my C code has nested groups for “Enumerations, Functions, Macros, Return Codes, and Typedefs?

In our system we have entities that we’re calling “Modules”, and so I don’t want to confuse readers. So I’d prefer that Doxygen output a different string in the resulting HTML.

2. So aside from the mechanics of changing the string, is there a suggestion as to what to call this group? I’m thinking “Entities” is nicely generic and still accurate for a C library?

Thanks,
-Monique

[Doxygen-users] at-signs (@) in doc comments are deleted from output

[dougkramer <dou...@gm...>]

My source code has three comments where Doxygen deletes @ signs from the
generated HTML:

/// [logIn setScopes:[NSArray
arrayWithObject:@"https://www.googleapis.com/auth/login"]];
@interface LogIn : NSObject

/// The default value is |@[@"https://www.xxx.com/auth/login"]|.
@property(nonatomic, copy) NSArray *scopes;

/// Such as |@"it"| or |@"pt-PT"|. Only set if different from system
default.
@property(nonatomic, copy) NSString *language;


The output is, respectively:

Source:    /// [logIn setScopes:[NSArray
arrayWithObject:@"https://www.xxx.com/
Generated:    [logIn setScopes:[NSArray arrayWithObject:"<a
href=&quot;https://www.xxx.com/
Should be:     [logIn setScopes:[NSArray arrayWithObject:@&quot;&lt;a
href=&quot;https://www.xxx.com/

Source:    /// The default value i
|@[@&quot;https://www.xxx.com/auth/login&quot;]|.
Generated:    The default value is |@[&quot;&lt;a
href=&quot;https://www.xxx.com/auth/login&quot;>
Should be:     The default value is |@[@" Source:     /// such as |@"it"| or
|@"pt-PT"|. 
Generated:     such as |"it"| or |@"pt-PT"|
Should be:      such as |@"it"| or |@"pt-PT"|


Is this a Doxygen bug?

In order to avoid altering the comments, my INPUT_FILTER is has only one
statement in it:  cat $1

Doxygen 1.8.8 <https://www.xxx.com/auth/login> 



--
View this message in context: http://doxygen.10944.n7.nabble.com/at-signs-in-doc-comments-are-deleted-from-output-tp7038.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

Re: [Doxygen-users] Disabling prefixing .md files with md_

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

ST,

The item 1) has already been answered by Christoph.

About removing the md_, I don't know what the design decision behind it
was. But you can write a patch for it or file an enhancement report for it
and see if it is honored.

2) I don't think it is wise to remove the .html extension, quite a few
users will use doxygen without a webserver, but maybe the setting:

HTML_FILE_EXTENSION    = "."

might be something for you (as far as I can see it removes all .html
extensions).


Albert

On Mon, Feb 9, 2015 at 7:43 PM, ST <sm...@gm...> wrote:

> 1. so how was it done in the official tutorial?
>
> http://www.stack.nl/~dimitri/doxygen/manual/install.html
>
> its install.html and not md_install.html...
>
> I want to generate a static web page using doxygen. install.html just
> looks nicer than md_install.html...
>
> 2. Is it possible to generate just install (without .html) and let the
> webserver treat it as an .html file?
>
> so it looks even nicer:
> http://www.stack.nl/~dimitri/doxygen/manual/install
>
> Thank you.
>
> On Mon, 2015-02-09 at 18:35 +0100, Albert wrote:
> > ST,
> >
> >
> > There is no way to disable it. The basename of the md file is
> > prepended by md_.
> >
> >
> > What is the background of your question?
> >
> >
> > Albert
> >
> >
> > On Mon, Feb 9, 2015 at 12:58 PM, ST <sm...@gm...> wrote:
> >         Hi,
> >
> >         all html files generated from .md files get prefixed with md_
> >         like
> >         md_<file_name>.html . Is there a way to disable this md_?
> >
> >         thank you,
> >         ST
> >
> >
> >
>  ------------------------------------------------------------------------------
> >         Dive into the World of Parallel Programming. The Go Parallel
> >         Website,
> >         sponsored by Intel and developed in partnership with Slashdot
> >         Media, is your
> >         hub for all things parallel software development, from weekly
> >         thought
> >         leadership blogs to news, videos, case studies, tutorials and
> >         more. Take a
> >         look and join the conversation now.
> >         http://goparallel.sourceforge.net/
> >         _______________________________________________
> >         Doxygen-users mailing list
> >         Dox...@li...
> >         https://lists.sourceforge.net/lists/listinfo/doxygen-users
> >
> >
>
>

Re: [Doxygen-users] Disabling prefixing .md files with md_

[Christoph L. <chr...@li...>]

Am 09.02.2015 um 19:43 schrieb ST:
> 1. so how was it done in the official tutorial?
>
> http://www.stack.nl/~dimitri/doxygen/manual/install.html
>
> its install.html and not md_install.html...

The Doxygen documentation resides in files with a ".doc" extension, each 
of which essentially contains a huge C-style comment block. An example 
can be found here:

https://github.com/doxygen/doxygen/blob/master/doc/install.doc

Re: [Doxygen-users] Disabling prefixing .md files with md_

[ST <sm...@gm...>]

1. so how was it done in the official tutorial?

http://www.stack.nl/~dimitri/doxygen/manual/install.html

its install.html and not md_install.html...

I want to generate a static web page using doxygen. install.html just
looks nicer than md_install.html...

2. Is it possible to generate just install (without .html) and let the
webserver treat it as an .html file?

so it looks even nicer:
http://www.stack.nl/~dimitri/doxygen/manual/install

Thank you.

On Mon, 2015-02-09 at 18:35 +0100, Albert wrote:
> ST,
> 
> 
> There is no way to disable it. The basename of the md file is
> prepended by md_.
> 
> 
> What is the background of your question?
> 
> 
> Albert
> 
> 
> On Mon, Feb 9, 2015 at 12:58 PM, ST <sm...@gm...> wrote:
>         Hi,
>         
>         all html files generated from .md files get prefixed with md_
>         like
>         md_<file_name>.html . Is there a way to disable this md_?
>         
>         thank you,
>         ST
>         
>         
>         ------------------------------------------------------------------------------
>         Dive into the World of Parallel Programming. The Go Parallel
>         Website,
>         sponsored by Intel and developed in partnership with Slashdot
>         Media, is your
>         hub for all things parallel software development, from weekly
>         thought
>         leadership blogs to news, videos, case studies, tutorials and
>         more. Take a
>         look and join the conversation now.
>         http://goparallel.sourceforge.net/
>         _______________________________________________
>         Doxygen-users mailing list
>         Dox...@li...
>         https://lists.sourceforge.net/lists/listinfo/doxygen-users
> 
> 

[Doxygen-users] Disabling prefixing .md files with md_

[ST <sm...@gm...>]

Hi,

all html files generated from .md files get prefixed with md_ like
md_<file_name>.html . Is there a way to disable this md_?

thank you,
ST

[Doxygen-users] A problem with call graph generation in c++

[Anurag M. <anu...@gm...>]

Hi,

I am almost certain this is a problem with my configuration file. Can
someone here please guide me on this?


I have two files :


a.h is:

class A{
    public:
        virtual void func(){printf ("class A func\n\n");}};

b.h is :

#include "a.h"class B:public A{
    public:
       void func1(){}
       void func(){printf ("class B func\n\n");A::func();func1();}};


in my configuration file:
CALL_GRAPH=yes
GENERATE_XML=yes
EXTRACT_ALL = YES
EXTRACT_PRIVATE = YES
RECURSIVE              = YES
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION    = YES

In the list of references of B::func(), the call graph shows func1 but DOES
NOT show A::func().
I am assuming I have a missing argument in my configuration file. Can
someone please help? I have been stuck on this for quite some time now.

Thank you,
Anurag Murty

[Doxygen-users] Doxygen as a static site generator?

[ST <sm...@gm...>]

Hello,

I want to write a small static website and currently looking around for
tools do it. It has to get Markdown files as input.

There seem to be a lot of options:

https://staticsitegenerators.net/

But I prefer to use Doxygen for this purpose, because of 2 reasons:

1. I need to use doxygen anyway to generate docs from the source code,
so I prefer to learn and use only one tool.
2. The docs from the source code will have the same look and feel with
the rest of the web site.

My questions on those who know well the features provided by Doxygen:

1. What are the pros/cons of using Doxygen instead of those tools?
2. Which features does Doxygen lack compared to let's say 2 most popular
tools - [Jekyll](jekyllrb.com) and [Pelican](getpelican.com)?
3. Are there some free themes/templates for Doxygen?

Thank you in advance,
ST

ps: maybe it makes sense to add Doxygen to the above mentioned list?

[Doxygen-users] Overridden selectors

[Alessandro A. <ant...@gm...>]

Hi, all.

I'm wonder how to do this kind of documentation correctly. The language is
Objective-C and this is my case.

I have an interface that implements a standard protocol. The declaration is
like this:

@interface MyInterface : NSObject < NSCopying > {
}
@end

'NSCopying' has the 'copyWithZone:' selector and it is implemented in
'MyInterface' implementation:

@implementation MyInterface
- (id)copyWithZone:(NSZone *)zone
{
    // ... code removed for brevity
    return something;
}
@end

In Objective-C overridden selectors are not declared in the interface
declaration. So, what is the correct way to document the implementation of
'copyWithZone:'?  Since it is not declared in the 'interface' declaration it
is assumed by Doxygen to be a local selector. This is right. I don't want
local operations to show up in the documentation. But I do want some
overridden selectors to appear in the documentation. How could I accomplish
that?

[Doxygen-users] Identifying directories

[Christoph L. <chr...@li...>]

Assuning I have a project with a directory tree layout similar to the 
following:

    (base directory)
     |
     |- a
     |  |- b
     |  |- c
     |
     |- c

Is there any way to I identify c (as opposed to a/c) in doxygen tags 
(such as @dir)?

[Doxygen-users] Split Documentation of templated static function

[Torbjörn K. <ope...@to...>]

Hello,

I've a set of templated static functions inside a namespace and split up 
definitions and declarations in "my_funcs.hpp" and "my_funcs_impl.hpp". Some of 
the functions are overloaded.

I'm aiming at providing general API related documentation with the 
declarations in "my_funcs.hpp" and want to provide additional internal (via 
`\internal`) documentation with the definitions in "my_funcs_impl.hpp".

However, Doxygen will not pick up any documentation I'm providing with the 
definitions, but issues "warning: no matching file member found for" for each 
overloaded function.

I managed to fix the warning by opening the namespaces in the same way as with 
the declarations resulting in each function to occur twice in the Doxygen 
output (the second without any content).

How can I achieve the desired output while still keeping the documentation 
split up?

Kind regards,
Torbjörn



Example Code:

my_funcs.hpp:

namespace examples
{
namespace util
{
/**
 * general API docu of convenience function
 */
template<typename T>
static T func1(const vector<T>& d);

/**
 * \overload static T func1(typename vector<T>::const_iterator _f, typename 
vector<T>::const_iterator _e)
 * general API docu of function
 */
template<typename T>
static T func1(typename vector<T>::const_iterator _f, typename 
vector<T>::const_iterator _e);
}
}


my_funcs_impl.hpp:


#include "my_funcs.hpp"

/**
 * calls overloaded function
 */
template<typename T>
static T examples::util::func1(const vector<T>& d)
{
  return func1(d.cbegin(), d.cend());
}

/**
 * \internal uses std::inner_product
 */
template<typename T>
static T examples::util::func1(typename vector<T>::const_iterator _f, typename 
vector<T>::const_iterator _e)
{
  return std::inner_product(_f, _e, _f, T(0.0));
}

Re: [Doxygen-users] function into another in python

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

Olivier,

Looks to me something with the automatic use of Markdown feature of
Doxygen, seeing the spaces in second and further lines of the """ parts as
code block parts.
Please try with MARKDOWN_SUPPORT = NO
Also try to run doxygen with -d filteroutput to see what the doxypy filter
gives as output.

Albert


On Tue, Feb 3, 2015 at 9:24 AM, Olivier Munier <re...@fr...> wrote:

> Hello,
>
> I wanted to use Doxygen to generate the documentation of my software in
> Python.
> I use doxypy <http://code.foosel.org/doxypy>and all was fine until I need
> to type this kind of code :
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
>
> *179     def downloadFile(self, path):180         """181         This
> function read the file pointed by path182         @param path an absolute
> path to the file to be read183         @return the datas of the read file
> as a StringIO object184         """185         d = Deferred()186
> attr_dict = {}187         file_str = StringIO()188 189         def
> fileOpen(file_desc):190             """191             """192
> def _finished(failure):193                 reason =
> failure.trap(EOFError)194                 if reason !=
> EOFError:195                     stderr.write(196
> "download of {file} was cancel by
> {reason}\n".format(197
> file=path,198
> reason=reason199                         )200
> )201                 file_str.seek(0)202
> d.callback(file_str)203
> file_desc.close()204                 file_str.close()205 206
> def _data_read(data):207                 """208                 Read the
> content of the file (by 2^16 octets packet)209                 write the
> datas in the local file_type object210                 @param data a part
> of the reading file211                 """212
> file_str.write(data)213
> file_desc.readChunk(214
> len(file_str.getvalue()),215
> attr_dict['size']216
> ).addCallback(_data_read).addErrback(_finished)217 218
> file_desc.readChunk(219                 0,220
> attr_dict['size']221
> ).addCallback(_data_read).addErrback(_finished)222 223         def
> readAttrs(attrs):224             """225             Get the attributes of
> the file and use them to open the file*
>
> and I see doxygen (or doxypy I'm not sure) don't support the function into
> another function.
> and return a result like that :
>
> http://img11.hostingpics.net/pics/268799doxygen.png
>
> Is it a missing function or maybe I made something wrong ?
>
> Regards.
>
>
>
>
>
> ------------------------------------------------------------------------------
> Dive into the World of Parallel Programming. The Go Parallel Website,
> sponsored by Intel and developed in partnership with Slashdot Media, is
> your
> hub for all things parallel software development, from weekly thought
> leadership blogs to news, videos, case studies, tutorials and more. Take a
> look and join the conversation now. http://goparallel.sourceforge.net/
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>

[Doxygen-users] function into another in python

[Olivier M. <re...@fr...>]

Hello, 

I wanted to use Doxygen to generate the documentation of my software in Python. 
I use doxypy and all was fine until I need to type this kind of code : 

179 def downloadFile(self, path): 
180 """ 
181 This function read the file pointed by path 
182 @param path an absolute path to the file to be read 
183 @return the datas of the read file as a StringIO object 
184 """ 
185 d = Deferred() 
186 attr_dict = {} 
187 file_str = StringIO() 
188 
189 def fileOpen(file_desc): 
190 """ 
191 """ 
192 def _finished(failure): 
193 reason = failure.trap(EOFError) 
194 if reason != EOFError: 
195 stderr.write( 
196 "download of {file} was cancel by {reason}\n".format( 
197 file=path, 
198 reason=reason 
199 ) 
200 ) 
201 file_str.seek(0) 
202 d.callback(file_str) 
203 file_desc.close() 
204 file_str.close() 
205 
206 def _data_read(data): 
207 """ 
208 Read the content of the file (by 2^16 octets packet) 
209 write the datas in the local file_type object 
210 @param data a part of the reading file 
211 """ 
212 file_str.write(data) 
213 file_desc.readChunk( 
214 len(file_str.getvalue()), 
215 attr_dict['size'] 
216 ).addCallback(_data_read).addErrback(_finished) 
217 
218 file_desc.readChunk( 
219 0, 
220 attr_dict['size'] 
221 ).addCallback(_data_read).addErrback(_finished) 
222 
223 def readAttrs(attrs): 
224 """ 
225 Get the attributes of the file and use them to open the file 

and I see doxygen (or doxypy I'm not sure) don't support the function into another function. 
and return a result like that : 

http://img11.hostingpics.net/pics/268799doxygen.png 

Is it a missing function or maybe I made something wrong ? 

Regards. 

[Doxygen-users] Grouping Pages?

[Christoph L. <chr...@li...>]

In addition to in-source docs, our project also uses various markdown 
pages providing additional information. At present, they all show up at 
the top level of the main index, like so:

     Extra Page 1
     Extra Page 2A
     Extra Page 2B
     Extra Page 3
     Todo List
     Deprecated List
     Namespaces
     Classes
     Files

Now I would like to group Extra Pages 2A and 2B together in the index, 
while still keeping them as separate HTML pages, like so:

     Extra Page 1
     Extra Page 2
         Extra Page 2A
         Extra Page 2B
     Extra Page 3
     Todo List
     ...

is that possible with Doxygen?

Re: [Doxygen-users] Tutorial Message Sequence Charts with Moritz is online

[Eckard K. <eck...@t-...>]

Hello Every Body.

I forgot to mention you will find the tutorial at
https://sourceforge.net/projects/moritz/files/Moritz_2.x/DevelopmentFor_2_1_0/Snapshot_2_0_2/Tutorials/
as zip-file
  04_MessageSequence.zip

Best Regards,
                          Eckard Klotz.


Am 01.02.2015 um 15:20 schrieb Eckard Klotz:
> Hello every body
>
> As already announced last year, a first tutorial was published today 
> to show how to create message sequence charts with Moritz. As for 
> nassi shneiderman or uml like activity diagrams Moritz generates no 
> images directly but image describing scripts in this case scripts for 
> the tool msgen you will find at
>    http://www.mcternan.me.uk/mscgen/
> Mscgen is already known by Doxygen and the script-files can be added 
> to the Doxygen output by using the command mscfile .
> This first version is published to introduce the new feature of Moritz 
> that is still under development. The goal is to ask the users to take 
> a look and to post some comments in the forum at
>     http://sourceforge.net/p/moritz/discussion/
> A pdf in tutorial describes the basic steps needed to create message 
> sequence charts. The provided folder "MessageSequence_1" contains the 
> example based on the same sources as the other tutorials.
>
> Please try it out and post a comment,
> Eckard Klotz.

[Doxygen-users] Tutorial Message Sequence Charts with Moritz is online

[Eckard K. <eck...@t-...>]

Hello every body

As already announced last year, a first tutorial was published today to 
show how to create message sequence charts with Moritz. As for nassi 
shneiderman or uml like activity diagrams Moritz generates no images 
directly but image describing scripts in this case scripts for the tool 
msgen you will find at
    http://www.mcternan.me.uk/mscgen/
Mscgen is already known by Doxygen and the script-files can be added to 
the Doxygen output by using the command mscfile .
This first version is published to introduce the new feature of Moritz 
that is still under development. The goal is to ask the users to take a 
look and to post some comments in the forum at
     http://sourceforge.net/p/moritz/discussion/
A pdf in tutorial describes the basic steps needed to create message 
sequence charts. The provided folder "MessageSequence_1" contains the 
example based on the same sources as the other tutorials.

Please try it out and post a comment,
Eckard Klotz.

Re: [Doxygen-users] MultiThread computing BUG

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

And also note that you can reduce the number of parallel processes via DOT_NUM_THREADS

Regards,
  Dimitri

> On 29 Jan 2015, at 18:51 , Albert <alb...@gm...> wrote:
> 
> This is not a bug but by design. In this case there are 8 separate threads used for generating dot files or better said to start the dot program for generating  graph and the main program occupies 1 thread. The 8 dot threads won't exhaust the processor as they do quite a bit of I/Oso the processes will wait for this I/O. Attempt is to make optimal use of the available (disc) resources.
> 
> Albert
> 
> On Thu, Jan 29, 2015 at 2:08 PM, Sima Zdenek SGD EXT <zde...@zf...> wrote:
> Hi,
> 
> I have laptop with Intel i7-4800MQ processor (4 cores, 8 threads). During Doxygen performance is my laptop totally frozen. I guess that the reason is using 9 threads by Doxygen.
> 
> Doxygen log file contains this information: generating dot graphs using 9 parallel threads
> 
>  
> 
> Regards
> 
> Zdenek
> 
> -- 
> ZF Lenksysteme GmbH, Richard-Bullinger-Str. 77, 73527 Schwäbisch Gmünd, Germany
> Vorsitzender des Aufsichtsrats/Chairman of the Supervisory Board: Wolf-Henning Scheider
> Geschäftsführung/Management Board: Christian Sobottka (Vorsitz/Chairman), Hanns Bernd Ketteler, Marcus Parche, Henning Wagner
> Sitz der Gesellschaft/Headquarters: Schwäbisch Gmünd - Handelsregistereintrag: Amtsgericht Ulm HRB 701678/Trade register of the municipal court of Ulm HRB 701678
> 
> 
> ------------------------------------------------------------------------------
> Dive into the World of Parallel Programming. The Go Parallel Website,
> sponsored by Intel and developed in partnership with Slashdot Media, is your
> hub for all things parallel software development, from weekly thought
> leadership blogs to news, videos, case studies, tutorials and more. Take a
> look and join the conversation now. http://goparallel.sourceforge.net/
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
> 
> 
> ------------------------------------------------------------------------------
> Dive into the World of Parallel Programming. The Go Parallel Website,
> sponsored by Intel and developed in partnership with Slashdot Media, is your
> hub for all things parallel software development, from weekly thought
> leadership blogs to news, videos, case studies, tutorials and more. Take a
> look and join the conversation now. http://goparallel.sourceforge.net/_______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users

[Doxygen-users] Maximizing warnings for missing doxygen

[Peter B. <pd...@ma...>]

Hello Folks,

I need help configuring Doxygen to generate warnings on *any* undocumented items.  

There are a few cases which seem to pass without warnings, despite the obvious Doxyfile config options.  There are other cases which generate warnings for parameters and return values, but only if the brief description ends with '.' (We have autobrief enabled).  See below for examples.

I think the relevant Doxyfile config parameters are:
> EXTRACT_ALL            = NO
> EXTRACT_PRIVATE        = YES
> EXTRACT_PACKAGE        = NO
> EXTRACT_STATIC         = yes
> EXTRACT_LOCAL_CLASSES  = YES
> EXTRACT_LOCAL_METHODS  = NO
> EXTRACT_ANON_NSPACES   = YES
> HIDE_UNDOC_MEMBERS     = NO
> HIDE_UNDOC_CLASSES     = NO
> HIDE_FRIEND_COMPOUNDS  = NO
> HIDE_IN_BODY_DOCS      = NO
> INTERNAL_DOCS          = YES
> JAVADOC_AUTOBRIEF      = YES
> QT_AUTOBRIEF           = YES
> 
> QUIET                  = NO
> WARNINGS               = YES
> WARN_IF_UNDOCUMENTED   = YES
> WARN_IF_DOC_ERROR      = YES
> WARN_NO_PARAMDOC       = YES
> WARN_FORMAT            = "$file:$line: $text"
> WARN_LOGFILE           = doxygen.log

Are there other configuration variables I should look at?  Or different values of these variables?

Thanks,
Peter

----------
Below are some examples which fail to generate warnings.  Where partial documentation is given, it doesn't matter whether it's JavaDoc style ('/** ... */'), Qt style ('/*! ... */') or C++ style ('/// ...').

> // Undoc'd named namespace.                       // NO WARN
> namespace undoc {
> 
> // Undoc'd func.
> void unsFuncUndoc (void);                         // warn function
> 
> /** Doc'd func with undoc'd param */              // NO WARN
> void unsFuncUndocArg (int foo);
> 
> /** Doc'd func with undoc'd return value */       // NO WARN
> int unsFuncUndocReturn (void);
> 
> }  // namespace undoc


The undocumented function gets a warning, but undocumented parameters or return value don't.  If the namespace itself is documented, all of these cases generate warnings.

Another namespace example:

> // Undoc'd anonymous namespace.                   // NO WARN
> namespace  {
>  …
> }  // anonymous namespace


Undocumented namespaces, either named or anonymous, don't seem to generate any warnings ever.


> // Undoc'd default constructor
> class Foo {
>    Foo (void);                                  // NO WARN

> };


Constructors with parameters do generate a warning (but see below).


Here's another set which fail to generate warnings *unless the brief description ends with '.'*

> /** \file */  // Required to trigger warnings at global scope:
> 

> /** Doc'd func with undoc'd param */              // DOT WARN parameters
> void FuncUndocArg (int foo);
> 
> /** Doc'd func with undoc'd return */             // DOT WARN return
> int FuncUndocReturn (void);


> // Undoc'd anonymous namespace or doc'd named namespace
> // (See above for undoc'd named namespace)
> namespace  {
> 
> /** Doc'd func with undoc'd param */              // DOT WARN parameters
> void ansFuncUndocArg (int foo);
> 
> /** Doc'd func with undoc'd return */             // DOT WARN return
> int ansFuncUndocReturn (void);
> 
> }  // anonymous namespace



> class Foo
> {
> 
>  // public or private:
> 
>  /** Doc'd (public) ctor with undoc'd param */   // DOT WARN parameters
>  ClassUndoc (int foo);
> 
>  /** Doc'd member func with undoc'd param */     // DOT WARN parameters
>  void pubMemFuncUndocArg (int foo);
> 
>  /** Doc'd member func with undoc'd return */    // DOT WARN return
>  int pubMemFuncUndocReturn (void);


(These are from a longer test file, which marks each statement with the type of warning, or lack thereof, on the same line as reported by doxygen.  I can forward that if it would be helpful.)

Thanks,
Peter

In case versions matter:   doxygen 1.8.9.1, Mac 10.8.5, gcc 4.2.1.
____________
Peter Barnes
pd...@ma...

Re: [Doxygen-users] Doxygen-users Digest, Vol 104, Issue 11

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

On Thu, Jan 29, 2015 at 11:21 AM, <
dox...@li...> wrote:

>
> Date: Thu, 29 Jan 2015 17:21:08 +0100
> From: Fabian Cenedese <Cen...@in...>
> Subject: [Doxygen-users] Multiple functions with same name
>
> I'm developing a C-project where I have basically the same code for several
> variants of controllers. A few functions need to be adjusted and are placed
> in separate files. The interface of course is for all the same. For linking
> only the necessary files will be linked in. I don't want to create a
> separate
> documentation for every controller where only little details change. But
> documenting all files will lead to merged documentation of the functions
> with the same name.
>
> Little example:
>
> /* interface */
> a.h
> void DoA(void);
>
> /* implementation ctrl 1 */
> a1.c
> void DoA(void) {
> }
>
> /* implementation ctrl 2 */
> a2.c
> void DoA(void) {
> }
>

Assuming the main part of the function documentation is located in the .h
file, perhaps in the .c files use named paragraphs to "delimit" the
implementation specific details. Something like:

     /** @par Ctrl 1 Implementation
          Details about ctrl 1 implementation
     */

and similar for the other implementation specific function definitions.

Re: [Doxygen-users] MultiThread computing BUG

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

This is not a bug but by design. In this case there are 8 separate threads
used for generating dot files or better said to start the dot program for
generating  graph and the main program occupies 1 thread. The 8 dot threads
won't exhaust the processor as they do quite a bit of I/Oso the processes
will wait for this I/O. Attempt is to make optimal use of the available
(disc) resources.

Albert

On Thu, Jan 29, 2015 at 2:08 PM, Sima Zdenek SGD EXT <
zde...@zf...> wrote:

>  Hi,
>
> I have laptop with Intel i7-4800MQ processor (4 cores, *8 threads*).
> During Doxygen performance is my laptop totally frozen. I guess that the
> reason is using *9 threads* by Doxygen.
>
> Doxygen log file contains this information: *g**enerating dot graphs
> using 9 parallel threads*
>
>
>
> Regards
>
> Zdenek
>  --
>
> ZF Lenksysteme GmbH, Richard-Bullinger-Str. 77, 73527 Schwäbisch Gmünd,
> Germany
> Vorsitzender des Aufsichtsrats/Chairman of the Supervisory Board:
> Wolf-Henning Scheider
> Geschäftsführung/Management Board: Christian Sobottka (Vorsitz/Chairman),
> Hanns Bernd Ketteler, Marcus Parche, Henning Wagner
> Sitz der Gesellschaft/Headquarters: Schwäbisch Gmünd -
> Handelsregistereintrag: Amtsgericht Ulm HRB 701678/Trade register of the
> municipal court of Ulm HRB 701678
>
>
> ------------------------------------------------------------------------------
> Dive into the World of Parallel Programming. The Go Parallel Website,
> sponsored by Intel and developed in partnership with Slashdot Media, is
> your
> hub for all things parallel software development, from weekly thought
> leadership blogs to news, videos, case studies, tutorials and more. Take a
> look and join the conversation now. http://goparallel.sourceforge.net/
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>

[Doxygen-users] Multiple functions with same name

[Fabian C. <Cen...@in...>]

Hi

I know that this question has been asked before, but none of the results
in the internet really solved my problem. I also wanted to see if doxygen
may have new features to help with this problem.

I'm developing a C-project where I have basically the same code for several
variants of controllers. A few functions need to be adjusted and are placed
in separate files. The interface of course is for all the same. For linking
only the necessary files will be linked in. I don't want to create a separate
documentation for every controller where only little details change. But
documenting all files will lead to merged documentation of the functions
with the same name.

Little example:

/* interface */
a.h
void DoA(void);

/* implementation ctrl 1 */
a1.c
void DoA(void) {
}

/* implementation ctrl 2 */
a2.c
void DoA(void) {
}

For the binary only a1 or a2 will be linked in. As the implementation details
might be important I also want to include all *.c files in the documentation.
But they should stay separate and not merged together.

I already tried out groups but that didn't work.

Thanks

bye Fabi