doxygen-users — List for users of doxygen

Re: [Doxygen-users] Creating links in and between Markdown files/pages

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

Hi Paul,

On 19 Jun 2014, at 13:28 , Paul Anton Letnes <pa...@le...> wrote:

> Greetings, documentation enthusiasts.
> 
> I have created a simple doxygen example (see attached file). What I want to make (for now) is a "User Manual" style document. Later I will include source code documentation, but for now, I am looking to implement the current user manual in Markdown + doxygen. In this document, it would be nice to be able to create links both inside a single page, and between pages. However, I can't see a way of doing this in the Markdown syntax supported by Doxygen.
> 
> I am perfectly willing to accept something along the lines of a "\page foo" or "\label foo" directive (i.e. syntax outside Markdown)  once per file/top section header, but it would be beneficial to keep this doxygen-specific stuff to an absolute minimum, as we hope to use the same Markdown source for several purposes.
> 
> Links are essential for HTML output. For LaTeX/PDF we can live without, but it sure would be a great thing to have there, too. Can anyone help me with this?

There are two ways:

1) If you have a page with header label, i.e. 

# Tips and tricks for formatting Markdown correctly {#tips}

you can simply use "@ref tips".

Note that the subsequent sections have to be at the same level as the title in order 
for them to be rendered as sections within the page (you can call this a bug):

# Quotes {#quo}

...

# Links {#links}

...

Then you can refer to the sections using @ref quo and @ref links.

2) If do not have a header label for a page, i.e.

# Tips and tricks for formatting Markdown correctly

so without the {#...} part, then you have to use @ref md_<page_base_name> to link to the page, i.e. @ref md_tips and @md_introduction.

I hope this helps.

Regards,
  Dimitri

[Doxygen-users] Creating links in and between Markdown files/pages

[Paul A. L. <pa...@le...>]

Greetings, documentation enthusiasts.

I have created a simple doxygen example (see attached file). What I want 
to make (for now) is a "User Manual" style document. Later I will 
include source code documentation, but for now, I am looking to 
implement the current user manual in Markdown + doxygen. In this 
document, it would be nice to be able to create links both inside a 
single page, and between pages. However, I can't see a way of doing this 
in the Markdown syntax supported by Doxygen.

I am perfectly willing to accept something along the lines of a "\page 
foo" or "\label foo" directive (i.e. syntax outside Markdown)  once per 
file/top section header, but it would be beneficial to keep this 
doxygen-specific stuff to an absolute minimum, as we hope to use the 
same Markdown source for several purposes.

Links are essential for HTML output. For LaTeX/PDF we can live without, 
but it sure would be a great thing to have there, too. Can anyone help 
me with this?

Best regards, and thanks for creating this awesome tool.
Paul

[Doxygen-users] TAGFILES not working consistently in 1.8.7 (RHEL6)

[Keith R. <Kei...@ne...>]

Hi, we have just upgraded from 1.8.6 to 1.8.7 and appear to be having an issue with TAGFILES since the upgrade. We have multiple source repositories with each one generating their own documentation and their own tag file. We then link the documentation by using the TAGFILES facility. E.g.

Project A uses Project B tag file

This worked fine in 1.8.6, but since moving to 1.8.7 certain (random?) \ref links within Project A into Project B no longer work and we are seeing errors output from doxygen like so:

index:-1: warning: multiple use of section label 'index', (first occurrence: index)
/source/project-a/doc/mainpage.doxy:2: warning: multiple use of section label 'index', (first occurrence: index)

Interestingly though, if Project A is rebuilt using 1.8.7 but Project B is not rebuilt using 1.8.7 and left as a 1.8.6 build, the \ref links work fine. It is only when Project B is also rebuilt using 1.8.7 that this happens.

Any idea what is going on?

Keith

[Doxygen-users] using external tools for markdown parsing

[Paul A. L. <pa...@le...>]

Hi!

The markdown support of Doxygen is great - but sometimes I need more features, which e.g. pandoc [0] support. Specifically, for documentation outside the source tree (e.g. user manual) I would like to run my .markdown files through an external tool (pandoc) to convert them into html.

Can I set this in the Doxyfile, or do I have to write my own little script to do this conversion?

Cheers
Paul


[0] http://johnmacfarlane.net/pandoc/

[Doxygen-users] Doxygen tag in markdown file code span messes up output

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

I'm working on a .md page that describes coding style for a project; 
when I place the following in the .md file, Doxygen does not behave as 
expected:

~~~~~~~~
Some Doxygen syntax features require particular Doxygen configuration 
settings,
or even externaltools. The following can be freely used:

   - Automatic brief descriptions (`JAVADOC_AUTOBRIEF=YES`). Please 
avoid using
     the `@brief` tag.
   - Markdown (`MARKDOWN_SUPPORT= YES`). Please avoid tags wherever 
markdown is
     easier to read (e.g.,use `_foo_` instead of `@e foo` for emphasis).
   - (etc.)
~~~~~~~~

What I would expect:
Doxygen should not interpret any of the tags inside backtick code spans, 
and instead render them verbatim in the output.

What happens:
Doxygen interprets the character sequence "@brief` tag." as specifying a 
brief description for the page, and strips it from the output. 
Furthermore, the code span is interpreted as still being open, messing 
up all the following text.

Note that if I replace "@brief" with any other tag (or at least any I 
did test), it is rendered verbatim as expected.

- Is this a known problem?

- Is there any sane workaround to get this particular tag to be rendered 
verbatim as in-line code?

[Doxygen-users] C typedefs - treeview left pane erroneously showing final struct's details for all structs

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

Hello, doxygen-users,

I’m using Doxygen 1.8.5 to document a C library. And although the treeview output’s left pane *lists* all the different “typedef struct” items, the details that are shown in the left pane when you expand ANY of the items are the details of whatever is the final “typedef struct” in the parsed .h file.

That is, in the left pane (I’ve got GENERATE_TREEVIEW = YES), the correct three structures are listed (STRUCT_ONE, STRUCT_TWO, and STRUCT_THREE), but when you expand them in the tree, the treeview incorrectly shows the details of the final typedef struct (STRUCT_THREE) for ALL the data structures.

But the right pane—the details of the typedef structs—correctly shows the proper elements for all the structures.

Has anyone run into this? Were you able to fix it?

There’s nothing odd about any of the particular structures. And if I rearrange the order, whatever becomes the last struct in the file ends up as the one whose details are listed in the left pane when you expand any of the structs.

The other oddity is that in the treeview (although I think it’s unavoidable, but perhaps related to the problem) has the expected “Data Structures” item at the same level as “Modules” and the .page files that I’ve got. But when you expand that “Data Structures” element, the sub-elements are another “Data Structures”, which is where the bad details are shown for the STRUCT_ONE and STRUCT_TWO items, and a “Data Fields” element, which when expanded shows “All” and “Variables”. The right pan responds as expected when you click “All” and “Variables”: all the elements of all the typedefs are shown.

I have INLINE_SIMPLE_STRUCTS=YES, TYPEDEF_HIDES_STRUCT=YES, INHERIT_DOCS=YES, and OPTIMIZE_OUTPUT_FOR_C=YES, which seem to be the relevant settings.

If I change settings to not be for treeview (GENERATE_TREEVIEW=NO and DISABLE_INDEX=NO), of course the problem disappears, but of course so does the desired treeview.

typedefs are of the following style:

/**
* \brief Brief-desc.
* \details Details-desc.
* \version cur-ver
* \since orig-ver
* \ingroup typedefs-group
*/
typedef struct structOne {
    char    name[MAX_SIZE];
    unsigned int len;
    ENUM_NAME var;
} STRUCT_ONE;

/**
* \brief Brief-desc.
* \details Details-desc.
* \version cur-ver
* \since orig-ver
* \ingroup typedefs-group
*/
typedef struct structTwo {
    const char   *name;
    unsigned int ver;
} STRUCT_TWO;

/**
* \brief Brief-desc.
* \details Details-desc.
* \version cur-ver
* \since orig-ver
* \ingroup typedefs-group
*/
typedef struct structThree {
    unsigned int numElements;
    STRUCT_TWO    elements[MAX_SIZE];
} STRUCT_THREE;

Thanks for any leads,
-Monique

Re: [Doxygen-users] Doxywizard won't compile (RHEL6)

[Saner D. <dan...@in...>]

Hello,

Yes, that's where I looked. The 'doxygen' binary is generated fine and shows up in the 'bin' directory, but nothing else is built.

Thanks for the Qt 4 hint! I compiled Qt 4.8.2 (through great nuisance and expenditure of time I might add, haha) and pointed Doxygen's build configuration to it instead of Qt 5.3.0. Now the doxywizard binary is built fine! Interestingly, I still get the same "Nothing to be done for 'first'" message from gmake towards the end of the build process, from within the doxywizard directory. But I guess the binary is already being built somewhere earlier in the process.

So I'm fine now with a working Doxygen including GUI, thanks again for your help!
If I can help figuring out the issue when building with Qt 5.3.0, such as supplying logs of my failed build attempts, let me know.

Cheers
Daniel


________________________________________
From: Dimitri van Heesch [do...@gm...]
Sent: 03 June 2014 20:27
To: Saner  Daniel
Cc: dox...@li...
Subject: Re: [Doxygen-users] Doxywizard won't compile (RHEL6)

To avoid the obvious: where did you look for the doxywizard binary?
it should be generated in ../../bin (relative to the doxywizard source dir, where also the doxygen binary resides).

So far I never tried to compile doxygen with Qt5, only Qt4, so this might be a problem as well.

Regards,
  Dimitri

Re: [Doxygen-users] Doxywizard won't compile (RHEL6)

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

On 03 Jun 2014, at 14:50 , Saner Daniel <dan...@in...> wrote:

> Hi all,
>  
> for the past two days I’ve been unsuccessfully trying to compile Doxygen with the Doxywizard GUI on my RHEL 6 machine. The latest version of Doxygen offered by official RH repositories is almost 5 years old, which won’t do, and as the binary package doesn’t include Doxywizard, compilation is my only option. I’m not a Linux software compilation and installation wizard (obviously).
>  
> The configure script runs through without errors, including successful detection of Qt 5.3.0 libraries. I also tried forcing the platform from the autodetected linux-g++ to linux-64, as I have the 64-bit version of Qt 5.3.0 installed, to no effect. Compilation using make also runs through without errors, but towards the end, when it would be doxywizard’s turn to compile, I get the following output:
>  
> gmake[2]: Entering directory `/home/daniel/Downloads/doxygen/addon/doxywizard'
> gmake[2]: Nothing to be done for `first'.
> gmake[2]: Leaving directory `/home/daniel/Downloads/doxygen/addon/doxywizard'
> gmake[1]: Leaving directory `/home/daniel/Downloads/doxygen/addon/doxywizard'
>  
> The Makefile.doxywizard file in the addon/doxywizard subdirectory looks fine to my inexperienced eyes (it’s not empty or anything), but I simply cannot get it to actually compile anything. Hence, of course, a subsequent make install fails as it cannot find the doxywizard binary.
>  
> I tried both the current source tarball from the website, as well as a direct Git repository clone, but both fail to do anything at all about actually trying to compile doxywizard. How can I get this thing built?

To avoid the obvious: where did you look for the doxywizard binary? 
it should be generated in ../../bin (relative to the doxywizard source dir, where also the doxygen binary resides).

So far I never tried to compile doxygen with Qt5, only Qt4, so this might be a problem as well.

Regards,
  Dimitri

[Doxygen-users] Doxywizard won't compile (RHEL6)

[Saner D. <dan...@in...>]

Hi all,

for the past two days I've been unsuccessfully trying to compile Doxygen with the Doxywizard GUI on my RHEL 6 machine. The latest version of Doxygen offered by official RH repositories is almost 5 years old, which won't do, and as the binary package doesn't include Doxywizard, compilation is my only option. I'm not a Linux software compilation and installation wizard (obviously).

The configure script runs through without errors, including successful detection of Qt 5.3.0 libraries. I also tried forcing the platform from the autodetected linux-g++ to linux-64, as I have the 64-bit version of Qt 5.3.0 installed, to no effect. Compilation using make also runs through without errors, but towards the end, when it would be doxywizard's turn to compile, I get the following output:

gmake[2]: Entering directory `/home/daniel/Downloads/doxygen/addon/doxywizard'
gmake[2]: Nothing to be done for `first'.
gmake[2]: Leaving directory `/home/daniel/Downloads/doxygen/addon/doxywizard'
gmake[1]: Leaving directory `/home/daniel/Downloads/doxygen/addon/doxywizard'

The Makefile.doxywizard file in the addon/doxywizard subdirectory looks fine to my inexperienced eyes (it's not empty or anything), but I simply cannot get it to actually compile anything. Hence, of course, a subsequent make install fails as it cannot find the doxywizard binary.

I tried both the current source tarball from the website, as well as a direct Git repository clone, but both fail to do anything at all about actually trying to compile doxywizard. How can I get this thing built?

Thanks
Daniel

[Doxygen-users] how to numbering automatically in table?

[h. <472...@qq...>]

Hello !When I create a table like this:


|number|item|
|:----:|:----:|
|1|xx|
|2|xx|

..
|100|xx|


how can I create the number automatically?


thanks for help!

[Doxygen-users] Doxygen for Gradle

[Schalk Cronjé <ys...@gm...>]

Hi All,

I have recently created a plugin for Gradle to support Doxygen. Although 
the Doxygen extension for Ant can be used in Gradle via Antbulder, iI 
was looking for something more gradlesque i.e use the Gradle DSL to 
configure documentation generation. Gradle has been having native 
support for building C/C++/Obj-C projects for the last number of 
versions and I thought it appropriate to add support for the most 
popular documentaton tool for these languages.

it is downloadable from Bintray 
(https://bintray.com/ysb33r/grysb33r/doxygen-gradle-plugin/view) and the 
source code is hosted on Github 
(https://github.com/ysb33r/Gradle/tree/master/doxygen)


It is still at 0.1, but is already functional. If people want to try it 
out and give feedback via Github issues (or here), I can improve it.

-- 
Schalk W. Cronjé
@ysb33r

[Doxygen-users] Collect All Instances of Tags and File Types

[doxyfool <Oma...@gd...>]

Is there a way in doxygen to gather and output all instances of a tag? In my
project, I repeatedly use an alias tag I created called /@action/ like so:

/// @action{First Object}
/// @action{Second Object}
...
...

and now I would like to gather all the "Objects" tagged throughout my code
using the @action tag and output them to a custom page. Is there any way to
do this?
Similarly, is there any way to output all files of a certain type to a
custom page? I would like to list the filenames of all the .idl files in my
project under one custom page, but I can't find a way to collect all of a
certain file type. The way I am currently doing it is commenting in every
.idl file:

/// @page customPage
/// currentIdlFileName.idl

However, this is very cumbersome.
Any help on either of these issues is greatly appreciated!



--
View this message in context: http://doxygen.10944.n7.nabble.com/Collect-All-Instances-of-Tags-and-File-Types-tp6675.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

[Doxygen-users] Escape Function Comments

[doxyfool <Oma...@gd...>]

Is there a way to post comments in the function prototype without those
comments being picked up as part of the function comments?
For example, in the comments above a function prototype, I use tags to
define aspects of the function. However, I then want one of the aspects
discussed to be passed to another html page generated by Doxygen. It would
be neatest if I could add this code immediately when I mention the argument
in the function comment block. Is there a way to reference a Doxygen page or
resource outside of the current function comments that you are working in?

If the question is confusing, hopefully the following image clarifies it.
The unhighlighted comments work perfectly to describe the function. But I
then want to add the "DREXi.b5" line to another html page which is separate
from my function comments.

<http://doxygen.10944.n7.nabble.com/file/n6673/example.png> 

Any help is appreciated. Thank you.



--
View this message in context: http://doxygen.10944.n7.nabble.com/Escape-Function-Comments-tp6673.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

Re: [Doxygen-users] Passing a .dox file that is not included in the related pages (tab type="pages") tab?

[doxyfool <Oma...@gd...>]

I've actually done a strange workaround that got the job done.
Instead of declaring my new pages as pages with the @page tag, I declared
them as groups with the @defgroup tag. Then I made the tabs point to those
groups using: url="@ref groupname".
Groups are stored under the "Modules" tab, so I simply set the "Modules" tab
visibility to "no". Now, the new "pages" (which are really groups) don't
appear listed under the "Related Pages" tab, and I can click their tabs and
go to the pages that I want.

The one issue with this workaround is that the tab I choose is not
highlighted. So when I am on the page that I created, there is no tab
selected. But since my page heading is the same as the title on the tab, it
is easy to figure out. And it doesn't redirect to the "Related Pages" tab at
least, so that's better.



--
View this message in context: http://doxygen.10944.n7.nabble.com/Passing-a-dox-file-that-is-not-included-in-the-related-pages-tab-type-pages-tab-tp6152p6672.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

Re: [Doxygen-users] Don't List Pages Under "Related Pages" tab

[doxyfool <Oma...@gd...>]

I've actually done a strange workaround that got the job done.
Instead of declaring my new pages as pages with the @page tag, I declared
them as groups with the @defgroup tag. Then I made the tabs point to those
groups using: url="@ref groupname".
Groups are stored under the "Modules" tab, so I simply set the "Modules" tab
visibility to "no". Now, the new "pages" (which are really groups) don't
appear listed under the "Related Pages" tab, and I can click their tabs and
go to the pages that I want.

The one issue with this workaround is that the tab I choose is not
highlighted. So when I am on the page that I created, there is no tab
selected. But since my page heading is the same as the title on the tab, it
is easy to figure out. And it doesn't redirect to the "Related Pages" tab at
least, so that's better.



--
View this message in context: http://doxygen.10944.n7.nabble.com/Don-t-List-Pages-Under-Related-Pages-tab-tp6668p6671.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

Re: [Doxygen-users] Don't List Pages Under "Related Pages" tab

[doxyfool <Oma...@gd...>]

Thanks Dimitri,

I've actually changed the name of the Related Pages tab already, but left
that detail out because I wasn't sure if it was relevant to the issue I was
having. Still, thank you very much for your input.



--
View this message in context: http://doxygen.10944.n7.nabble.com/Don-t-List-Pages-Under-Related-Pages-tab-tp6668p6670.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

Re: [Doxygen-users] Don't List Pages Under "Related Pages" tab

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

On 29 May 2014, at 20:58 , doxyfool <Oma...@gd...> wrote:

> I have created some pages using the @page tag and have also made tabs that
> link to those pages using the url="@ref pageName". However, it seems that
> the new pages are housed under the "Related Pages" tab and when I click the
> tab associated with the new page, I am redirected to the new page under the
> "Related Pages" tab.
> Is there any way to detach newly created pages from the "Related Pages" tab
> and house them under other custom "user-type" tabs? I have seen other
> questions similar to this on the forum, but all were still unanswered.

Have a look here http://www.doxygen.org/manual/customize.html#layout
which at a minimum allows you to rename the "Related pages" to something else.

Note that for doxygen 2.0, I'm working on a much more flexible layout system based on 
Django-style templates, but this will probably take another year to complete.

Regards,
  Dimitri

[Doxygen-users] Don't List Pages Under "Related Pages" tab

[doxyfool <Oma...@gd...>]

I have created some pages using the @page tag and have also made tabs that
link to those pages using the url="@ref pageName". However, it seems that
the new pages are housed under the "Related Pages" tab and when I click the
tab associated with the new page, I am redirected to the new page under the
"Related Pages" tab.
Is there any way to detach newly created pages from the "Related Pages" tab
and house them under other custom "user-type" tabs? I have seen other
questions similar to this on the forum, but all were still unanswered.

Thanks for any help.



--
View this message in context: http://doxygen.10944.n7.nabble.com/Don-t-List-Pages-Under-Related-Pages-tab-tp6668.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

[Doxygen-users] How to use markdown feature.

[Rajmohan M. <msr...@gm...>]

Dear All,Greetings.I request examples to use the markdown feature.Thanks in
advance.Regards,Rajmohan



--
View this message in context: http://doxygen.10944.n7.nabble.com/How-to-use-markdown-feature-tp6667.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

[Doxygen-users] Howto customize header & footer in RTF output.

[Rajmohan M. <msr...@gm...>]

Hi All,Greetings.I am working to generate a API design document (RTF). I
request help please to complete the following: *1) customize RTFStylesheet
to include text and a logo in header 2) customize RTFStylesheetto include
text and page numbers in footer3) include an image (jpg or png) in any
section of the RTF output.4) customize title page of the design
document*Currently, I am able to include an image in any section of HTML but
not in RTF.I request detailed steps please.Thanks in advance.Best
Regards,Rajmohan



--
View this message in context: http://doxygen.10944.n7.nabble.com/Howto-customize-header-footer-in-RTF-output-tp6666.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

[Doxygen-users] Windows binaries available for 1.8.7-20140520 at SourceForge

[Petr P. <Pr...@sk...>]

Hi,

If interested, you can download the doxygen binaries
compiled for MS Windows from

  http://sourceforge.net/projects/doxygen/files/snapshots/doxygen-1.8-svn/windows

This is the place where you should find also the next
releases.  Name of the archive file is

  doxygenw20140520_1_8_7.zip

The Release64 is not present there. It did not compile on my machine.

The related translator report can be found inside the directory

  http://sourceforge.net/projects/doxygen/files/snapshots/doxygen-1.8-svn/translator_reports/

Name of the archive file is

  tr20140520_1_8_7.zip

The binaries are NOT created automatically, so it may
happen that some newer sources were not compiled
because I am not present to do that or I forgot... ;)

Regards,
    Petr

--
Petr Prikryl (prikryl at atlas dot cz)

Re: [Doxygen-users] search.php and Request.pm interaction causing searches to fail

[Scott F. <sco...@gm...>]

On 20/05/14 04:57 PM, Suzanne Brower wrote:
> We are using Doygen version 1.8.3.1 and php version 5.2.17.
Sue,
PHP is currently at ver 5.5.12 and Doxygen is 1.8.7.
Any reason you can't upgrade?

This may correct the search problem your having at the moment.

Scott

Re: [Doxygen-users] soliciting SME reviews for HTML output ?

[Scott F. <sco...@gm...>]

On 22/05/14 03:55 PM, Monique Semp wrote:
> Hello, doxygen-users,
> I’m using Doxygen to generate HTML output for a C++ library. Not all 
> the doc reviewers have direct access to the code that I’m commenting, 
> so I’ll need to solicit reviews by using the HTML output instead of 
> just having the engineers look at my code check-ins (for the doxygen 
> tags that I’m adding).
> So do you have any recommendations for workflow and for how reviewers 
> can provide input in an easier fashion than saying, “on the 
> blah-blah-blah.html page, third para in the \this-tag, the “old-text” 
> should be “new-text”?
> In theory I know that I can use Latex to create a PDF, which would 
> offer lots of commenting ability. But then the look-and-feel and 
> navigation is so different from what’s desired/delivered to the 
> customer that I doubt the value of such a time-consuming step.
> Thanks for your thoughts,
> -Monique
Monique,
Presuming there is no need to prevent access to the code because of 
security/propriety, can you expose the code via web page access?
The reviews may not be able to "edit" the code directly but may be able 
to submit changes via diff.

There are some methods available depending on how the library is stored 
or accessed. For example, if source code was in an subversion 
repository, you could use an Apache module for people to access the 
library via a web page.

This depends on how things are setup on your end.

Re: [Doxygen-users] soliciting SME reviews for HTML output ?

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

Hello Monique,

We use the Rietveld code review tool on Google Appspot for reviews of source code as well as doxygen source:
https://codereview.appspot.com

Of course, this means exposing your code outside your organization, and you're still reviewing source code, not the generated html.  Even for experienced Doxygen writers, the output isn't always what we expect ;) so there's no substitute for looking at things in the browser.

I'd be interested in what other hints you get.  Please post a summary to the list, or to me privately.

Thanks,
Peter

On May 22, 2014, at 2:55 PM, Monique Semp <mon...@ea...> wrote:

> Hello, doxygen-users,
>  
> I’m using Doxygen to generate HTML output for a C++ library. Not all the doc reviewers have direct access to the code that I’m commenting, so I’ll need to solicit reviews by using the HTML output instead of just having the engineers look at my code check-ins (for the doxygen tags that I’m adding).
>  
> So do you have any recommendations for workflow and for how reviewers can provide input in an easier fashion than saying, “on the blah-blah-blah.html page, third para in the \this-tag, the “old-text” should be “new-text”?
>  
> In theory I know that I can use Latex to create a PDF, which would offer lots of commenting ability. But then the look-and-feel and navigation is so different from what’s desired/delivered to the customer that I doubt the value of such a time-consuming step.
>  
> Thanks for your thoughts,
> -Monique
> ------------------------------------------------------------------------------
> "Accelerate Dev Cycles with Automated Cross-Browser Testing - For FREE
> Instantly run your Selenium tests across 300+ browser/OS combos.
> Get unparalleled scalability from the best Selenium testing platform available
> Simple to use. Nothing to install. Get started now for free."
> http://p.sf.net/sfu/SauceLabs_______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users

____________
Peter Barnes
pd...@ma...

[Doxygen-users] soliciting SME reviews for HTML output ?

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

Hello, doxygen-users,

I’m using Doxygen to generate HTML output for a C++ library. Not all the doc reviewers have direct access to the code that I’m commenting, so I’ll need to solicit reviews by using the HTML output instead of just having the engineers look at my code check-ins (for the doxygen tags that I’m adding).

So do you have any recommendations for workflow and for how reviewers can provide input in an easier fashion than saying, “on the blah-blah-blah.html page, third para in the \this-tag, the “old-text” should be “new-text”?

In theory I know that I can use Latex to create a PDF, which would offer lots of commenting ability. But then the look-and-feel and navigation is so different from what’s desired/delivered to the customer that I doubt the value of such a time-consuming step.

Thanks for your thoughts,
-Monique