doxygen-users — List for users of doxygen

Re: [Doxygen-users] are document generators dead?

[Paul J. <pau...@gm...>]

Doxygen is excellent and especially useful for C/C++ or "like-minded"
languages.   A few years ago I switched to developing
most of my code in Python and while Doxygen can handle this, it is not
ideal, in that case I turn to Sphinx which is ideal
for Python but also useful for general purpose API documentation:
http://sphinx-doc.org/    It is based on docutils and
reStructuredText, while I'm not the biggest fan of reStructuredText the
Sphinx additions make it very usable.

If you are looking for some REST API documentation tools I'd point you to
Swagger: https://helloreverb.com/developers/swagger

Paul Joireman

On Tue, Oct 7, 2014 at 7:21 AM, Robert Heller <he...@de...> wrote:

> At Mon, 6 Oct 2014 22:03:20 -0700 Tom Johnson <tom...@gm...>
> wrote:
>
> >
> >
> >
> > Are document generators for APIs dead? When I look over the possible
> > options out there, everything seems built about 10 years ago. I don't see
> > anything new coming out of this genre of tools. I find this odd, given
> that
> > APIs themselves are exploding in popularity.
> >
> > I'm guessing that most new APIs today are REST APIs, and none of the
> > current document generators really address REST?
> >
> > Can someone clue me in as to why there aren't more recently developed
> > tools? Doxygen seems to be the best of them, but even Doxygen seems a bit
> > dated to me.
>
> Define 'dated'...  What are you expecting?
>
> OTOH: "If it ain't broke, don't fix it."...
>
> >
> > Tom
> > ---------------------
> > 801-822-2241
> > blog: idratherbewriting.com
> > twitter: tomjohnson
> >
> > MIME-Version: 1.0
> >
> >
> ------------------------------------------------------------------------------
> > Meet PCI DSS 3.0 Compliance Requirements with EventLog Analyzer
> > Achieve PCI DSS 3.0 Compliant Status with Out-of-the-box PCI DSS Reports
> > Are you Audit-Ready for PCI DSS 3.0 Compliance? Download White paper
> > Comply to PCI DSS 3.0 Requirement 10 and 11.5 with EventLog Analyzer
> >
> http://pubads.g.doubleclick.net/gampad/clk?id=154622311&iu=/4140/ostg.clktrk
> > MIME-Version: 1.0
> >
> > _______________________________________________
> > Doxygen-users mailing list
> > Dox...@li...
> > https://lists.sourceforge.net/lists/listinfo/doxygen-users
> >
> >
>
> --
> Robert Heller             -- 978-544-6933
> Deepwoods Software        -- Custom Software Services
> http://www.deepsoft.com/  -- Linux Administration Services
> he...@de...       -- Webhosting Services
>
>
>
> ------------------------------------------------------------------------------
> Meet PCI DSS 3.0 Compliance Requirements with EventLog Analyzer
> Achieve PCI DSS 3.0 Compliant Status with Out-of-the-box PCI DSS Reports
> Are you Audit-Ready for PCI DSS 3.0 Compliance? Download White paper
> Comply to PCI DSS 3.0 Requirement 10 and 11.5 with EventLog Analyzer
>
> http://pubads.g.doubleclick.net/gampad/clk?id=154622311&iu=/4140/ostg.clktrk
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>



-- 
Paul W. Joireman
pau...@gm...

----------------------------------------------------------------
'Am I not destroying my enemies when I make friends of them? ."
-- Abraham Lincoln 1809-1865

Re: [Doxygen-users] are document generators dead?

[Robert H. <he...@de...>]

At Mon, 6 Oct 2014 22:03:20 -0700 Tom Johnson <tom...@gm...> wrote:

> 
> 
> 
> Are document generators for APIs dead? When I look over the possible
> options out there, everything seems built about 10 years ago. I don't see
> anything new coming out of this genre of tools. I find this odd, given that
> APIs themselves are exploding in popularity.
> 
> I'm guessing that most new APIs today are REST APIs, and none of the
> current document generators really address REST?
> 
> Can someone clue me in as to why there aren't more recently developed
> tools? Doxygen seems to be the best of them, but even Doxygen seems a bit
> dated to me.

Define 'dated'...  What are you expecting?

OTOH: "If it ain't broke, don't fix it."...

> 
> Tom
> ---------------------
> 801-822-2241
> blog: idratherbewriting.com
> twitter: tomjohnson
> 
> MIME-Version: 1.0
> 
> ------------------------------------------------------------------------------
> Meet PCI DSS 3.0 Compliance Requirements with EventLog Analyzer
> Achieve PCI DSS 3.0 Compliant Status with Out-of-the-box PCI DSS Reports
> Are you Audit-Ready for PCI DSS 3.0 Compliance? Download White paper
> Comply to PCI DSS 3.0 Requirement 10 and 11.5 with EventLog Analyzer
> http://pubads.g.doubleclick.net/gampad/clk?id=154622311&iu=/4140/ostg.clktrk
> MIME-Version: 1.0
> 
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
> 
>                                                                                          

-- 
Robert Heller             -- 978-544-6933
Deepwoods Software        -- Custom Software Services
http://www.deepsoft.com/  -- Linux Administration Services
he...@de...       -- Webhosting Services
                                                                                                                

Re: [Doxygen-users] are document generators dead?

[Adam T. W. <awi...@wh...>]

On Mon, 2014-10-06 at 22:03 -0700, Tom Johnson wrote: 
> Are document generators for APIs dead? When I look over the possible
> options out there, everything seems built about 10 years ago. I don't
> see anything new coming out of this genre of tools. I find this odd,
> given that APIs themselves are exploding in popularity.

Nothing new is required; this is a solved problem.  Solved about 10
years ago.

> I'm guessing that most new APIs today are REST APIs, and none of the
> current document generators really address REST?

???  REST APIs are 'theoretically' self-documenting.  Which is total BS,
but the trope REST fanboys hide behind.  Underlying any REST API is code
- an API written in source code - that needs to be documented.  And that
can be accomplished with the same tools. 
> Can someone clue me in as to why there aren't more recently developed
> tools? Doxygen seems to be the best of them, but even Doxygen seems a
> bit dated to me. 

Why is it "dated"?  Something that works is not obsolete.

-- 
Adam Tauno Williams <mailto:awi...@wh...> GPG D95ED383
Systems Administrator, Python Developer, LPI / NCLA

[Doxygen-users] are document generators dead?

[Tom J. <tom...@gm...>]

Are document generators for APIs dead? When I look over the possible
options out there, everything seems built about 10 years ago. I don't see
anything new coming out of this genre of tools. I find this odd, given that
APIs themselves are exploding in popularity.

I'm guessing that most new APIs today are REST APIs, and none of the
current document generators really address REST?

Can someone clue me in as to why there aren't more recently developed
tools? Doxygen seems to be the best of them, but even Doxygen seems a bit
dated to me.

Tom
---------------------
801-822-2241
blog: idratherbewriting.com
twitter: tomjohnson

[Doxygen-users] Re: FILTER_PATTERNS script worked in 1.8.7, fails in 1.8.8

[Andrew L. <dr...@me...>]

So, to answer my own question, between 1.8.7 and 1.8.8 the behavior for files of unrecognized extension changed from treat like C to don't parse. I fixed my problem by adding *.proto=C to EXTENSION_MAPPINGS in the doxyfile.

I am awaiting permission from clueless suits to return the improved filter to the community.

Re: [Doxygen-users] import html files?

[Tom J. <tom...@gm...>]

Interesting technique. Thanks for the tip. I probably have too many pages
to make this technique practical, but it's good to know you can do this
sort of thing in doxygen.

Tom

---------------------
801-822-2241
blog: idratherbewriting.com
twitter: tomjohnson

On Sun, Oct 5, 2014 at 10:37 AM, Albert <alb...@gm...> wrote:

> I had a similar problem, only that I wanted just a file with a table rows
> to be read into a page. I used the following trick:
>
> \htmlonly
>   <script src="jquery.js"></script>
>   <script>
>     $(function(){
>       $("#includedContent").load("file.html");
>     });
>   </script>
>
>   <table class="doxtable">
>     <thead>
>      <tr>
>        <th>File</th>
>        <th>Line</th>
>        <th>Message</th>
>       </tr>
>     </thead>
>     <tbody id="includedContent">
>     </tbody>
>   </table>
> \endhtmlonly
>
> One is self responsible for everything and there won't be any links
> generated by doxygen when it is generated.
>
> Doxygen is not able to interpret the entire HTML pages, but maybe
> translating the HTML to e.g. md and than feeding this to doxygen might give
> a possibility. See e.g. pandoc (http://johnmacfarlane.net/pandoc/), I
> have no experience with it so I don't know how easy it can be used and what
> the quality of the results will be.
>
> Albert
>
> On Fri, Oct 3, 2014 at 9:42 PM, Tom Johnson <tom...@gm...>
> wrote:
>
>> Any other ideas on how to get doxygen to include standalone html files? I
>> was really hoping to find a solution for merging source-generated doc with
>> other tutorial doc.
>>
>> Tom
>>
>> Sent from my iPhone
>>
>> > On Oct 1, 2014, at 3:45 AM, Willem Bogaerts <w-...@dd...> wrote:
>> >
>> > Dear Tom,
>> >
>> > I used this to include RFCs in my documentation. To do this, copy the
>> > HTML files somewhere in your project and make sure in can be found (in
>> > my example the ):
>> >
>> > in DoxyFile:
>> > EXAMPLE_PATH           = web/test \
>> >                         documentation/htmlincludes/ \
>> >
>> >
>> > In the source, I create pages:
>> > /// @page soap11 The SOAP specification, version 1.1
>> > /// @htmlinclude SOAP_1_1.html
>> >
>> > /// @page soap12 The SOAP specification, version 1.2
>> > /// @htmlinclude SOAP_1_2.html
>> >
>> > /// @page stylesandencodingsinsoap Styles and Encoding in SOAP messages
>> > /// @htmlinclude stylesandencodingsinsoap.html
>> >
>> > /// @page wsdl11 Web Service Description Language
>> > /// @htmlinclude WSDL_1_1.html
>> >
>> >
>> > The files referred to in the @htmlinclude commands are in
>> > documentation/htmlincludes/ .
>> >
>> > Best regards,
>> > Willem Bogaerts
>> >
>> >
>> >
>> >
>> ------------------------------------------------------------------------------
>> > Meet PCI DSS 3.0 Compliance Requirements with EventLog Analyzer
>> > Achieve PCI DSS 3.0 Compliant Status with Out-of-the-box PCI DSS Reports
>> > Are you Audit-Ready for PCI DSS 3.0 Compliance? Download White paper
>> > Comply to PCI DSS 3.0 Requirement 10 and 11.5 with EventLog Analyzer
>> >
>> http://pubads.g.doubleclick.net/gampad/clk?id=154622311&iu=/4140/ostg.clktrk
>> > _______________________________________________
>> > Doxygen-users mailing list
>> > Dox...@li...
>> > https://lists.sourceforge.net/lists/listinfo/doxygen-users
>>
>>
>> ------------------------------------------------------------------------------
>> Meet PCI DSS 3.0 Compliance Requirements with EventLog Analyzer
>> Achieve PCI DSS 3.0 Compliant Status with Out-of-the-box PCI DSS Reports
>> Are you Audit-Ready for PCI DSS 3.0 Compliance? Download White paper
>> Comply to PCI DSS 3.0 Requirement 10 and 11.5 with EventLog Analyzer
>>
>> http://pubads.g.doubleclick.net/gampad/clk?id=154622311&iu=/4140/ostg.clktrk
>> _______________________________________________
>> Doxygen-users mailing list
>> Dox...@li...
>> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>>
>
>

Re: [Doxygen-users] import html files?

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

I had a similar problem, only that I wanted just a file with a table rows
to be read into a page. I used the following trick:

\htmlonly
  <script src="jquery.js"></script>
  <script>
    $(function(){
      $("#includedContent").load("file.html");
    });
  </script>

  <table class="doxtable">
    <thead>
     <tr>
       <th>File</th>
       <th>Line</th>
       <th>Message</th>
      </tr>
    </thead>
    <tbody id="includedContent">
    </tbody>
  </table>
\endhtmlonly

One is self responsible for everything and there won't be any links
generated by doxygen when it is generated.

Doxygen is not able to interpret the entire HTML pages, but maybe
translating the HTML to e.g. md and than feeding this to doxygen might give
a possibility. See e.g. pandoc (http://johnmacfarlane.net/pandoc/), I have
no experience with it so I don't know how easy it can be used and what the
quality of the results will be.

Albert

On Fri, Oct 3, 2014 at 9:42 PM, Tom Johnson <tom...@gm...>
wrote:

> Any other ideas on how to get doxygen to include standalone html files? I
> was really hoping to find a solution for merging source-generated doc with
> other tutorial doc.
>
> Tom
>
> Sent from my iPhone
>
> > On Oct 1, 2014, at 3:45 AM, Willem Bogaerts <w-...@dd...> wrote:
> >
> > Dear Tom,
> >
> > I used this to include RFCs in my documentation. To do this, copy the
> > HTML files somewhere in your project and make sure in can be found (in
> > my example the ):
> >
> > in DoxyFile:
> > EXAMPLE_PATH           = web/test \
> >                         documentation/htmlincludes/ \
> >
> >
> > In the source, I create pages:
> > /// @page soap11 The SOAP specification, version 1.1
> > /// @htmlinclude SOAP_1_1.html
> >
> > /// @page soap12 The SOAP specification, version 1.2
> > /// @htmlinclude SOAP_1_2.html
> >
> > /// @page stylesandencodingsinsoap Styles and Encoding in SOAP messages
> > /// @htmlinclude stylesandencodingsinsoap.html
> >
> > /// @page wsdl11 Web Service Description Language
> > /// @htmlinclude WSDL_1_1.html
> >
> >
> > The files referred to in the @htmlinclude commands are in
> > documentation/htmlincludes/ .
> >
> > Best regards,
> > Willem Bogaerts
> >
> >
> >
> >
> ------------------------------------------------------------------------------
> > Meet PCI DSS 3.0 Compliance Requirements with EventLog Analyzer
> > Achieve PCI DSS 3.0 Compliant Status with Out-of-the-box PCI DSS Reports
> > Are you Audit-Ready for PCI DSS 3.0 Compliance? Download White paper
> > Comply to PCI DSS 3.0 Requirement 10 and 11.5 with EventLog Analyzer
> >
> http://pubads.g.doubleclick.net/gampad/clk?id=154622311&iu=/4140/ostg.clktrk
> > _______________________________________________
> > Doxygen-users mailing list
> > Dox...@li...
> > https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>
> ------------------------------------------------------------------------------
> Meet PCI DSS 3.0 Compliance Requirements with EventLog Analyzer
> Achieve PCI DSS 3.0 Compliant Status with Out-of-the-box PCI DSS Reports
> Are you Audit-Ready for PCI DSS 3.0 Compliance? Download White paper
> Comply to PCI DSS 3.0 Requirement 10 and 11.5 with EventLog Analyzer
>
> http://pubads.g.doubleclick.net/gampad/clk?id=154622311&iu=/4140/ostg.clktrk
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>

Re: [Doxygen-users] import html files?

[Tom J. <tom...@gm...>]

Any other ideas on how to get doxygen to include standalone html files? I was really hoping to find a solution for merging source-generated doc with other tutorial doc. 

Tom

Sent from my iPhone

> On Oct 1, 2014, at 3:45 AM, Willem Bogaerts <w-...@dd...> wrote:
> 
> Dear Tom,
> 
> I used this to include RFCs in my documentation. To do this, copy the
> HTML files somewhere in your project and make sure in can be found (in
> my example the ):
> 
> in DoxyFile:
> EXAMPLE_PATH           = web/test \
>                         documentation/htmlincludes/ \
> 
> 
> In the source, I create pages:
> /// @page soap11 The SOAP specification, version 1.1
> /// @htmlinclude SOAP_1_1.html
> 
> /// @page soap12 The SOAP specification, version 1.2
> /// @htmlinclude SOAP_1_2.html
> 
> /// @page stylesandencodingsinsoap Styles and Encoding in SOAP messages
> /// @htmlinclude stylesandencodingsinsoap.html
> 
> /// @page wsdl11 Web Service Description Language
> /// @htmlinclude WSDL_1_1.html
> 
> 
> The files referred to in the @htmlinclude commands are in
> documentation/htmlincludes/ .
> 
> Best regards,
> Willem Bogaerts
> 
> 
> 
> ------------------------------------------------------------------------------
> Meet PCI DSS 3.0 Compliance Requirements with EventLog Analyzer
> Achieve PCI DSS 3.0 Compliant Status with Out-of-the-box PCI DSS Reports
> Are you Audit-Ready for PCI DSS 3.0 Compliance? Download White paper
> Comply to PCI DSS 3.0 Requirement 10 and 11.5 with EventLog Analyzer
> http://pubads.g.doubleclick.net/gampad/clk?id=154622311&iu=/4140/ostg.clktrk
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users

[Doxygen-users] FILTER_PATTERNS script worked in 1.8.7, fails in 1.8.8

[Andrew L. <dr...@me...>]

I've been working on improving the open source Google Protobuf filters for Doxygen. The filter converts the protobuf message to a C++ struct and writes that to stdout. This worked (well) in 1.8.7. After upgrading, none of the messages appear in the documentation. By writing filenames to stderr from the script, I also see that the #include statements in the original output (translated from protobuf import) are being ignored. However, the script is getting called on each file.

I don't believe the failure arises from more careful checking of the script output, which is not legal C code. (The buffers' "optional" and "required" qualifiers are left in, and are printed by Doxygen in a useful way.) I say this because if I run the script on the .proto file manually and redirect stdout to a cpp file, that file will be parsed with correct documentation produced.

Re: [Doxygen-users] import html files?

[Tom J. <tom...@gm...>]

Thanks Willem. I appreciate your help. I tried following your instructions,
but I'm getting stuck somewhere and it's not quite working. Here's what I
did:

1. Added folder called htmlincludes on my Desktop.
2. Put some HTML files into this htmlincludes folder.
3. In the Doxygen GUI, on the Expert tab, for the Input topic, for
EXAMPLE_PATH, I added /Users/tjohnson/Desktop/htmlincludes.
4. In a sample helloworld.java, I added some references to @pages in the
source:

/**

 * Says hello to the world.

 * @author tjohnson

 * @category Sample

 * @version 1.0

 * @page DI ID Rating

 * @htmlincludes di_id_rating.html

 * @page DI Overview

 * @htmlincludes di_overview.html

 *

 */

public class HelloWorld {

  public static void main(String[] args) {

 System.out.println("Hello world!");

 }

}


(Note: I actually wasn't sure where I was supposed to put these references.
I think this might be where I'm going wrong.)

5. Clicked Run to generate Doxygen.

However, no HTML files were included in the Doxygen output.

The only way can seem to get external files included in Doxygen's output is
by putting the files into the source folder. The files have to be in
markdown format with an md extension in order to get included in the output.

I really just want Doxygen to include some HTML files. This seems like a
reasonable task.

Tom



---------------------
801-822-2241
blog: idratherbewriting.com
twitter: tomjohnson

On Wed, Oct 1, 2014 at 3:45 AM, Willem Bogaerts <w-...@dd...> wrote:

> Dear Tom,
>
> I used this to include RFCs in my documentation. To do this, copy the
> HTML files somewhere in your project and make sure in can be found (in
> my example the ):
>
> in DoxyFile:
> EXAMPLE_PATH           = web/test \
>                          documentation/htmlincludes/ \
>
>
> In the source, I create pages:
> /// @page soap11 The SOAP specification, version 1.1
> /// @htmlinclude SOAP_1_1.html
>
> /// @page soap12 The SOAP specification, version 1.2
> /// @htmlinclude SOAP_1_2.html
>
> /// @page stylesandencodingsinsoap Styles and Encoding in SOAP messages
> /// @htmlinclude stylesandencodingsinsoap.html
>
> /// @page wsdl11 Web Service Description Language
> /// @htmlinclude WSDL_1_1.html
>
>
> The files referred to in the @htmlinclude commands are in
> documentation/htmlincludes/ .
>
> Best regards,
> Willem Bogaerts
>
>
>
>
> ------------------------------------------------------------------------------
> Meet PCI DSS 3.0 Compliance Requirements with EventLog Analyzer
> Achieve PCI DSS 3.0 Compliant Status with Out-of-the-box PCI DSS Reports
> Are you Audit-Ready for PCI DSS 3.0 Compliance? Download White paper
> Comply to PCI DSS 3.0 Requirement 10 and 11.5 with EventLog Analyzer
>
> http://pubads.g.doubleclick.net/gampad/clk?id=154622311&iu=/4140/ostg.clktrk
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>

Re: [Doxygen-users] import html files?

[Willem B. <w-...@dd...>]

Dear Tom,

I used this to include RFCs in my documentation. To do this, copy the
HTML files somewhere in your project and make sure in can be found (in
my example the ):

in DoxyFile:
EXAMPLE_PATH           = web/test \
                         documentation/htmlincludes/ \


In the source, I create pages:
/// @page soap11 The SOAP specification, version 1.1
/// @htmlinclude SOAP_1_1.html

/// @page soap12 The SOAP specification, version 1.2
/// @htmlinclude SOAP_1_2.html

/// @page stylesandencodingsinsoap Styles and Encoding in SOAP messages
/// @htmlinclude stylesandencodingsinsoap.html

/// @page wsdl11 Web Service Description Language
/// @htmlinclude WSDL_1_1.html


The files referred to in the @htmlinclude commands are in
documentation/htmlincludes/ .

Best regards,
Willem Bogaerts

[Doxygen-users] import html files?

[Tom J. <tom...@gm...>]

I have some HTML files that I'm trying to include in Doxygen. I'm at a loss
for how to do this.

Here's what I tried. I'm using the Doxygen GUI Frontend to configure the
Doxygen processing. I put the HTML files in the same directory as my other
source files. On the Expert tab, I selected input and added *.html as a
file pattern. Then I ran Doxygen. No luck.

It seems that the only content Doxygen recognizes (other than the source
code files) is files with an md extension.

I know markdown is a shorthand syntax for HTML. However, I'm generating my
HTML files from an XML format called DITA, so I don't want to change all my
doc source files to markdown.

How can I get Doxygen to pull in my HTML files?

Thanks,

Tom
---------------------
801-822-2241
blog: idratherbewriting.com
twitter: tomjohnson

Re: [Doxygen-users] Bug with markdown for numbered lists?

[Robert D. <rcd...@gm...>]

Thank you Phillip. I misread the wording on that page. I'm used to 1.
1. working, so it threw me off. I'll just go ahead and use sequential
numbering, it makes the code comment more readable anyway :-)

On Tue, Sep 30, 2014 at 12:54 PM, Philip Grenon
<phi...@or...> wrote:
> Robert,
>
> According to the markdown support page (http://www.stack.nl/~dimitri/doxygen/manual/markdown.html), "An item with an equal or lower number than the preceding item, will start a new list."
>
> You can either list them in ascending order, or use '-#' for each bullet item.
>
> -- Philip Grenon
>
> -----Original Message-----
> From: Robert Dailey [mailto:rcd...@gm...]
> Sent: Tuesday, September 30, 2014 1:42 PM
> To: Doxygen
> Subject: [Doxygen-users] Bug with markdown for numbered lists?
>
> I have the following Doxygen documentation block in C++:
> http://pastebin.com/9jBZtV9q
>
> As you can see, I use consecutive 1's to number my lists programmatically (I want Doxygen to do the numbers for me). When I use this format, however, the formatting for the numbered lists does not work. Instead, it treats it like 2 separate lists. Here is a screenshot of the HTML output:
> http://i.imgur.com/XlSv8i1.png
>
> When I change the list to 1. and 2. instead of 1. and 1., it works as expected (screenshot of correct and expected HTML formatting):
> http://i.imgur.com/6ouSHZ9.png
>
> Is this a bug? If not, how can I properly get the formatting to work without manually numbering my lists?
>
> ------------------------------------------------------------------------------
> Meet PCI DSS 3.0 Compliance Requirements with EventLog Analyzer Achieve PCI DSS 3.0 Compliant Status with Out-of-the-box PCI DSS Reports Are you Audit-Ready for PCI DSS 3.0 Compliance? Download White paper Comply to PCI DSS 3.0 Requirement 10 and 11.5 with EventLog Analyzer http://pubads.g.doubleclick.net/gampad/clk?id=154622311&iu=/4140/ostg.clktrk
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users

Re: [Doxygen-users] Bug with markdown for numbered lists?

[Philip G. <phi...@or...>]

Robert, 

According to the markdown support page (http://www.stack.nl/~dimitri/doxygen/manual/markdown.html), "An item with an equal or lower number than the preceding item, will start a new list."

You can either list them in ascending order, or use '-#' for each bullet item.

-- Philip Grenon

-----Original Message-----
From: Robert Dailey [mailto:rcd...@gm...] 
Sent: Tuesday, September 30, 2014 1:42 PM
To: Doxygen
Subject: [Doxygen-users] Bug with markdown for numbered lists?

I have the following Doxygen documentation block in C++:
http://pastebin.com/9jBZtV9q

As you can see, I use consecutive 1's to number my lists programmatically (I want Doxygen to do the numbers for me). When I use this format, however, the formatting for the numbered lists does not work. Instead, it treats it like 2 separate lists. Here is a screenshot of the HTML output:
http://i.imgur.com/XlSv8i1.png

When I change the list to 1. and 2. instead of 1. and 1., it works as expected (screenshot of correct and expected HTML formatting):
http://i.imgur.com/6ouSHZ9.png

Is this a bug? If not, how can I properly get the formatting to work without manually numbering my lists?

------------------------------------------------------------------------------
Meet PCI DSS 3.0 Compliance Requirements with EventLog Analyzer Achieve PCI DSS 3.0 Compliant Status with Out-of-the-box PCI DSS Reports Are you Audit-Ready for PCI DSS 3.0 Compliance? Download White paper Comply to PCI DSS 3.0 Requirement 10 and 11.5 with EventLog Analyzer http://pubads.g.doubleclick.net/gampad/clk?id=154622311&iu=/4140/ostg.clktrk
_______________________________________________
Doxygen-users mailing list
Dox...@li...
https://lists.sourceforge.net/lists/listinfo/doxygen-users

[Doxygen-users] Bug with markdown for numbered lists?

[Robert D. <rcd...@gm...>]

I have the following Doxygen documentation block in C++:
http://pastebin.com/9jBZtV9q

As you can see, I use consecutive 1's to number my lists
programmatically (I want Doxygen to do the numbers for me). When I use
this format, however, the formatting for the numbered lists does not
work. Instead, it treats it like 2 separate lists. Here is a
screenshot of the HTML output:
http://i.imgur.com/XlSv8i1.png

When I change the list to 1. and 2. instead of 1. and 1., it works as
expected (screenshot of correct and expected HTML formatting):
http://i.imgur.com/6ouSHZ9.png

Is this a bug? If not, how can I properly get the formatting to work
without manually numbering my lists?

[Doxygen-users] Doxygen tag file handling for xml

[Jörg K. <j.k...@pr...>]

i!

i splitted my libraries and programs into several folders and was able to generate doxygen documentation for each folder and link them together using the "External documentation" / Tagfile feature of doxygen.
This was great!

Now i want to do something similar, but with the xml output:

What i want to achieve:

i want to use the sphinx / breathe / doxygen toolchain for documentation generation.

Is the tag file handling in doxygen considered for something else like html? or can it be used for xml also?

Mannheim HRB 504702
Geschäftsführer: Dipl.-Ing. (FH) Michael Brenk (Vorsitzender), Dipl.-Ing. (FH) Dipl.-Inf. (FH) Jens Heyen

This e-mail may contain confidential and/or legally protected information. If you are not the intended recipient (or have received this e-mail in error) please notify the sender immediately and delete this e-mail. Any unauthorized copying, disclosure or distribution of the material in this email is strictly forbidden.
Thank you!

Re: [Doxygen-users] removing line numbers from code blocks

[Peter A. B. <pa...@pa...>]

This behavior change was introduced by:

commit 0dd59398b3f62288897c8c3405977a27a94fbfee
Author: Dimitri van Heesch <di...@st...>
Date:   Mon Aug 4 14:07:53 2014 +0200

     Bug 734099 - Add support for non-parsed language

which caused the existing hard-coded TRUE showLineNumbers parameter to 
FileParser::parseCode to take effect in html.

I've filed this as bug #737472 and have worked around it by rebuilding 
with FALSE passed for the corresponding call in htmldocvisitor.cpp.

Peter

On 09/25/2014 09:00 AM, Peter A. Bigot wrote:
> Sometime around or before doxygen 1.8.8 html format documentation
> generated from the \code command started including line numbers.  While
> in many cases this might be useful, it breaks my use of this command to
> provide boilerplate code I expect users to cut and paste because the
> line numbers get captured in the copy.
>
> I can't find any obvious configuration parameter to control this. Is
> there one?
>
> Peter
>
> ------------------------------------------------------------------------------
> Meet PCI DSS 3.0 Compliance Requirements with EventLog Analyzer
> Achieve PCI DSS 3.0 Compliant Status with Out-of-the-box PCI DSS Reports
> Are you Audit-Ready for PCI DSS 3.0 Compliance? Download White paper
> Comply to PCI DSS 3.0 Requirement 10 and 11.5 with EventLog Analyzer
> http://pubads.g.doubleclick.net/gampad/clk?id=154622311&iu=/4140/ostg.clktrk
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users

Re: [Doxygen-users] Windows binaries available for 1.8.8-20140924 at SourceForge

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

Hi Markus,

It is quite complex to get the clang feature working on Windows, so this is not part of Petr's binary.
If you don't need/use it, then you can ignore the warning. If you do then stick with the official release.

Regards,
  Dimitri

On 24 Sep 2014, at 17:26 , starfuryAll <mar...@al...> wrote:

> Hi.
> When using this binaries I get this warnings:
> 
>> Warning: Tag `CLANG_ASSISTED_PARSING' at line 989 of file
>> `ABS_UBH_accounting.doxyfile' belongs to an option that was not enabled at
>> compile time.
>>         To avoid this warning please remove this line from your
>> configuration file or upgrade it using "doxygen -u", or recompile doxygen
>> with this feature enabled.
>> Warning: Tag `CLANG_OPTIONS' at line 997 of file
>> `ABS_UBH_accounting.doxyfile' belongs to an option that was not enabled at
>> compile time.
>>         To avoid this warning please remove this line from your
>> configuration file or upgrade it using "doxygen -u", or recompile doxygen
>> with this feature enabled.
> 
> Regards, Markus
> 
> 
> 
> --
> View this message in context: http://doxygen.10944.n7.nabble.com/Windows-binaries-available-for-1-8-8-20140924-at-SourceForge-tp6807p6809.html
> Sent from the Doxygen - Users mailing list archive at Nabble.com.
> 
> ------------------------------------------------------------------------------
> Meet PCI DSS 3.0 Compliance Requirements with EventLog Analyzer
> Achieve PCI DSS 3.0 Compliant Status with Out-of-the-box PCI DSS Reports
> Are you Audit-Ready for PCI DSS 3.0 Compliance? Download White paper
> Comply to PCI DSS 3.0 Requirement 10 and 11.5 with EventLog Analyzer
> http://pubads.g.doubleclick.net/gampad/clk?id=154622311&iu=/4140/ostg.clktrk
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users

Re: [Doxygen-users] Java: Annotations prevent Doxygen from documenting class (completely)

[starfuryAll <mar...@al...>]

Created a bug for *doxygen* at /GNOME bugzilla/: 
https://bugzilla.gnome.org/show_bug.cgi?id=737444




--
View this message in context: http://doxygen.10944.n7.nabble.com/Java-Annotations-prevent-Doxygen-from-documenting-class-completely-tp6802p6814.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

Re: [Doxygen-users] Subpage IDs using periods confuse the tree view

[Philip G. <phi...@or...>]

I tried using quotes as well as escaping the ‘.’, with no success. Doxygen treating ‘.’ as a separator seems likely, as subpaging “this” twice in the overview produces the same structure. Alternatively, the extra “this” subpage isn’t created after changing the ID of “this.that” to “that.this”, but the “that.this” page is still at the default level. 

 

-- Philip 

 

From: Albert [mailto:alb...@gm...] 
Sent: Thursday, September 25, 2014 2:15 PM
To: Philip Grenon
Cc: dox...@li...
Subject: Re: [Doxygen-users] Subpage IDs using periods confuse the tree view

 

I didn't look into it but the '.' is most of the time a separator so this could explain the behavior.

Did you try to place quotes around this.that ?

Albert

 

On Thu, Sep 25, 2014 at 8:08 PM, Philip Grenon <HYPERLINK "mailto:phi...@or..."phi...@or...> wrote:

Hi,

 

I am using pages and subpages to create a tree view, and I ran into an issue with subpage ids that use periods. These four example pages illustrate the problem:

 

/** @mainpage notitle

- @subpage overview 

 */

 

/** 

@page overview overview

- @subpage this

- @subpage this.that

*/

 

/*!

@page this this 

*/

 

/*!

@page this.that this.that

*/

 

I expected “this” and “this.that” to be subpages of “overview”, but instead, overview has “this” as a subpage twice. Additionally, “this.that” is left at the default level (a subpage of the main page). 

 

Is this behavior expected? 

 

-- Philip 

 


------------------------------------------------------------------------------
Meet PCI DSS 3.0 Compliance Requirements with EventLog Analyzer
Achieve PCI DSS 3.0 Compliant Status with Out-of-the-box PCI DSS Reports
Are you Audit-Ready for PCI DSS 3.0 Compliance? Download White paper
Comply to PCI DSS 3.0 Requirement 10 and 11.5 with EventLog Analyzer
http://pubads.g.doubleclick.net/gampad/clk?id=154622311&iu=/4140/ostg.clktrk
_______________________________________________
Doxygen-users mailing list
HYPERLINK "mailto:Dox...@li..."Dox...@li...
https://lists.sourceforge.net/lists/listinfo/doxygen-users

 

Re: [Doxygen-users] Subpage IDs using periods confuse the tree view

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

I didn't look into it but the '.' is most of the time a separator so this
could explain the behavior.
Did you try to place quotes around this.that ?

Albert

On Thu, Sep 25, 2014 at 8:08 PM, Philip Grenon <phi...@or...>
wrote:

> Hi,
>
>
>
> I am using pages and subpages to create a tree view, and I ran into an
> issue with subpage ids that use periods. These four example pages
> illustrate the problem:
>
>
>
> /** @mainpage notitle
>
> - @subpage overview
>
>  */
>
>
>
> /**
>
> @page overview overview
>
> - @subpage this
>
> - @subpage this.that
>
> */
>
>
>
> /*!
>
> @page this this
>
> */
>
>
>
> /*!
>
> @page this.that this.that
>
> */
>
>
>
> I expected “this” and “this.that” to be subpages of “overview”, but
> instead, overview has “this” as a subpage twice. Additionally, “this.that”
> is left at the default level (a subpage of the main page).
>
>
>
> Is this behavior expected?
>
>
>
> -- Philip
>
>
>
>
> ------------------------------------------------------------------------------
> Meet PCI DSS 3.0 Compliance Requirements with EventLog Analyzer
> Achieve PCI DSS 3.0 Compliant Status with Out-of-the-box PCI DSS Reports
> Are you Audit-Ready for PCI DSS 3.0 Compliance? Download White paper
> Comply to PCI DSS 3.0 Requirement 10 and 11.5 with EventLog Analyzer
>
> http://pubads.g.doubleclick.net/gampad/clk?id=154622311&iu=/4140/ostg.clktrk
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>

[Doxygen-users] Subpage IDs using periods confuse the tree view

[Philip G. <phi...@or...>]

Hi,

 

I am using pages and subpages to create a tree view, and I ran into an issue with subpage ids that use periods. These four example pages illustrate the problem:

 

/** @mainpage notitle

- @subpage overview 

 */

 

/** 

@page overview overview

- @subpage this

- @subpage this.that

*/

 

/*!

@page this this 

*/

 

/*!

@page this.that this.that

*/

 

I expected "this" and "this.that" to be subpages of "overview", but instead, overview has "this" as a subpage twice. Additionally, "this.that" is left at the default level (a subpage of the main page). 

 

Is this behavior expected? 

 

-- Philip 

 

[Doxygen-users] removing line numbers from code blocks

[Peter A. B. <pa...@pa...>]

Sometime around or before doxygen 1.8.8 html format documentation 
generated from the \code command started including line numbers.  While 
in many cases this might be useful, it breaks my use of this command to 
provide boilerplate code I expect users to cut and paste because the 
line numbers get captured in the copy.

I can't find any obvious configuration parameter to control this. Is 
there one?

Peter

Re: [Doxygen-users] Windows binaries available for 1.8.8-20140924 at SourceForge

[starfuryAll <mar...@al...>]

Hi.
When using this binaries I get this warnings:

> Warning: Tag `CLANG_ASSISTED_PARSING' at line 989 of file
> `ABS_UBH_accounting.doxyfile' belongs to an option that was not enabled at
> compile time.
>          To avoid this warning please remove this line from your
> configuration file or upgrade it using "doxygen -u", or recompile doxygen
> with this feature enabled.
> Warning: Tag `CLANG_OPTIONS' at line 997 of file
> `ABS_UBH_accounting.doxyfile' belongs to an option that was not enabled at
> compile time.
>          To avoid this warning please remove this line from your
> configuration file or upgrade it using "doxygen -u", or recompile doxygen
> with this feature enabled.

Regards, Markus



--
View this message in context: http://doxygen.10944.n7.nabble.com/Windows-binaries-available-for-1-8-8-20140924-at-SourceForge-tp6807p6809.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

Re: [Doxygen-users] Java: Annotations prevent Doxygen from documenting class (completely)

[starfuryAll <mar...@al...>]

FYI: Just tested  1.8.8-20140924
<http://doxygen.10944.n7.nabble.com/Windows-binaries-available-for-1-8-8-20140924-at-SourceForge-td6807.html>  
- The problem still exists.



--
View this message in context: http://doxygen.10944.n7.nabble.com/Java-Annotations-prevent-Doxygen-from-documenting-class-completely-tp6802p6808.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.