doxygen-users — List for users of doxygen

[Doxygen-users] VHDL Function and '=>' Token

[Larry <la...@co...>]

Anyone know why Doxygen does not create links to VHDL Functions?  Here is a
simple example:



 packapackage MyLib_General_Purpose is

    2 end package MyLib_General_Purpose;

    3 package body MyLib_General_Purpose is

    4  function resize_and_clip(bits: integer) return signed is

    b begin

   10  end function; 

   11  end package body MyLib_General_Purpose;

   12 

   13 entity test is

   14 end entity test;

   15 architecture test1 of test is

   16  signal ReturnValue : signed;

   17 begin

   18  ReturnValue <= resize_and_clip(1); 

   19 end architecture test1;

 

(Doxygen was run with the generic config, except "optimize for VHDL" is
enabled.  )

I would expect to see a link from resize_and_clip(1) and to
resize_and_clip(bits: integer).  

I've tried function in C code and doxygen creates links to those just fine. 

 

I suspect the problem has something to do with this line in the vhdlparserjj
file which seems to treat it as a "Generic":

 
"addVhdlType(current->name.data(),b,Entry::VARIABLE_SEC,VhdlDocGen::GENERIC,
ss.data(),0,Public);"

But, I don't understand the addVhdlType function well enough to know how to
fix it.

 

 

Also, does anyone know how to fix this error with the precedence for the
'=>' token? 

Either of these lines work:
    variable max_clipped_value: signed(1 downto 0) := ((bits-1) => '0',
others => '1');

    variable max_clipped_value: signed(1 downto 0) := (1 => '0', others =>
'1');

*

But, this one throws an error on the "=>" symbole

    variable max_clipped_value: signed(bits-1 downto 0) := (bits-1 => '0',
others => '1');

 

I've found and fixed many issues with the vhdlparser.jj file (mostly around
the "generate-else" syntax), but I have not solved this one.

 

Thanks 

 

Larry

 

(Just in case the HTML code above becomes unreadable in the mailing list,
here is the raw text)

package MyLib_General_Purpose is

end package MyLib_General_Purpose;

package body MyLib_General_Purpose is

  function resize_and_clip(bits: integer) return signed is

  begin

 end function;       

end package body MyLib_General_Purpose;

 

entity test is

end entity test;

architecture test1 of test is

signal ReturnValue : signed;

begin

ReturnValue <= resize_and_clip(1); 

end architecture test1;

 

[Doxygen-users] Automatische Antwort: Problem with the @htmlinclude tag

[Reckwell J. (DC-AE/ESF5) <Jen...@bo...>]

Vielen Dank f?r die Nachricht. Leider bin ich bis zum 7.08.2017 nicht im B?ro. Ihre Nachricht wird nicht weiter geleitet und in dieser Zeit nur sporadisch gelesen.
Thank you for your Message. Unfortunately I'm out of office until August 7th 2017. Your message will not be forwarded and I will read the mails only sporadic during this time.

Mit freundlichen Gr??en / Best regards

Jens Reckwell

Engineering Automation Systems Control Functions Motion and CNC DC-IA/EAO5
Bosch Rexroth. The Drive & Control Company
Tel. +49(9352)18-5066
Fax +49(9352)18-4270
Jen...@bo...<mailto:Jen...@bo...>
www.boschrexroth.com<http://www.boschrexroth.com>

Bosch Rexroth AG
Bgm.-Dr.-Nebel-Str. 2
97816 Lohr am Main
GERMANY

Firmensitz: Stuttgart, Registrierung: Amtsgericht Stuttgart HRB 23192
Vorstand: Rolf Najork (Vorsitzender) , Dr. Markus Forschner; Dr. Steffen Haack; Dr. Bertram Hoffmann
Vorsitzender des Aufsichtsrats: Dr. Werner Struth

[Doxygen-users] Problem with the @htmlinclude tag

[Bob+ B. <dox...@ya...>]

Hi,
I am documenting my project with doxygen and I wanted to add some ppt to the documentation. So I have transform my ppt to html and than I put the transformed files in the same directory which I mentioned in the EXAMPLE_PATH of the configuration's file. Then I tried to include these html files using the @htmlinclude tag. I selected HTML OUTPUT but the files didn't appear at the output. 

Do you think the problem come from the conversion ppt->html ? Or else?
Regards
Dox

Re: [Doxygen-users] doxygen layout file with missing elements: is it valid?

[Mark <dox...@er...>]

> On Jul 5, 2017, at 13:22, Robert Dailey <rcd...@gm... <mailto:rcd...@gm...>> wrote:
> 
> Obviously I have <tab> elements under <navindex>; assume all of that
> is valid. Notice I removed every other top-level element under
> <doxygenlayout>. Seems to work fine (browsed a class's documentation).
> Didn't notice any visual issues.
> 
> Is this valid? Will doxygen use internal defaults for missing
> top-level elements in the layout XML?

I look forward to the answer.

If one of the added <tab> elements needs to point to a document for which tags are being imported, how do you reference that document?

Regards

    -Mark

[Doxygen-users] doxygen layout file with missing elements: is it valid?

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

So I have a doxygen layout XML file that I'm using for the sole
purpose of just adding a tab group with some tabs under it. I don't
care about the rest of it. Most importantly, when I upgrade Doxygen in
the future, I want the rest of the stuff to generate default like it
normally does as if the layout XML wasn't specified explicitly. I ran
a test with the following layout XML file contents:

<doxygenlayout version="1.0">
  <!-- Generated by doxygen 1.8.13 -->
  <!-- Navigation index tabs for HTML output -->
  <navindex>
    ...
  </navindex>
</doxygenlayout>

Obviously I have <tab> elements under <navindex>; assume all of that
is valid. Notice I removed every other top-level element under
<doxygenlayout>. Seems to work fine (browsed a class's documentation).
Didn't notice any visual issues.

Is this valid? Will doxygen use internal defaults for missing
top-level elements in the layout XML?

Re: [Doxygen-users] Creating a main "hub" for componentized documentation

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

Would still love some advice on this if possible.

On Thu, Jun 29, 2017 at 3:16 PM, Robert Dailey <rcd...@gm...> wrote:
> I have integrated Doxygen documentation generation into CMake via tag
> files. Each dependency on a library introduces a tag file dependency.
> So far all of this is going great; but there's no "central" landing
> page that connects everything together.
>
> What would be the best way to manage a central / main page of sorts to
> connect multiple index.html together? Note I found a really old answer
> that seems to touch on this over at stackoverflow:
>
> https://stackoverflow.com/a/11582562/157971
>
> However there is not very much detail on the layout.xml idea.
>
> What I plan to do is have our CI build server generate all
> documentation each night and push the entire documentation tree to an
> apache server. Ideally I could send out 1 URL to everyone that they
> can use to reach all documented components.
>
> Advice is appreciated!

[Doxygen-users] List of Libraries

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

Hi,

For my package, I have a script building the list of library needed by a given class.

I can execute this script for each class via the filter specified in Doxyfile in the INPUT_FILTER field.

The question is: how can I include this list of libraries in my html doxygen output ?

Right now I introduced a new keyword in my doc, It is parsed by my filter and the list of libraries is generated
in place of the keyword.

It works but I would like to avoid this extra keyword. I didn't find the way to do that.

The best would be to add an extra section like the inheritance tree. Is it possible ?

Thanks for any help.
Cheers,

Olivier Couet

Re: [Doxygen-users] Creating a main "hub" for componentized documentation

[Mark <dox...@er...>]

Hi Robert,

> On Jun 29, 2017, at 13:16, Robert Dailey <rcd...@gm...> wrote:
> 
> I have integrated Doxygen documentation generation into CMake via tag
> files. Each dependency on a library introduces a tag file dependency.

I have been trying to use tags. I get no errors from doxygen. The log even says “Reading tag file” but nothing from the tags shows up in the index or anywhere else in the document that is importing the tag file. Please point me at a working example showing both generation and import of tags.

> So far all of this is going great; but there's no "central" landing
> page that connects everything together.

I am looking for the same thing. So far I have not found an answer, not even by way of my query to this list. I hope you have better luck.

Regards

    -Mark

Re: [Doxygen-users] Creating a main "hub" for componentized documentation

[Mark <dox...@er...>]

> On Jun 29, 2017, at 15:09, Mark <dox...@er...> wrote:
> 
> Hi Robert,
> 
>> On Jun 29, 2017, at 13:16, Robert Dailey <rcd...@gm... <mailto:rcd...@gm...>> wrote:
>> 
>> I have integrated Doxygen documentation generation into CMake via tag
>> files. Each dependency on a library introduces a tag file dependency.
> 
> I have been trying to use tags. I get no errors from doxygen. The log even says “Reading tag file” but nothing from the tags shows up in the index or anywhere else in the document that is importing the tag file. Please point me at a working example showing both generation and import of tags.
> 
>> So far all of this is going great; but there's no "central" landing
>> page that connects everything together.
> 
> I am looking for the same thing. So far I have not found an answer, not even by way of my query to this list. I hope you have better luck.
> 

I tried to see how doxygen.org <http://doxygen.org/> does this but after some study it became clear to me that the doxygen source on github does not have the complete code used to generate doxygen.org <http://doxygen.org/>. So I got nowhere.

Regards

    -Mark

[Doxygen-users] Creating a main "hub" for componentized documentation

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

I have integrated Doxygen documentation generation into CMake via tag
files. Each dependency on a library introduces a tag file dependency.
So far all of this is going great; but there's no "central" landing
page that connects everything together.

What would be the best way to manage a central / main page of sorts to
connect multiple index.html together? Note I found a really old answer
that seems to touch on this over at stackoverflow:

https://stackoverflow.com/a/11582562/157971

However there is not very much detail on the layout.xml idea.

What I plan to do is have our CI build server generate all
documentation each night and push the entire documentation tree to an
apache server. Ideally I could send out 1 URL to everyone that they
can use to reach all documented components.

Advice is appreciated!

[Doxygen-users] ASN.1 support

[Raashid A. <ans...@ya...>]

Hi All,
Is there any support out there for ASN.1 through Doxygen? Maybe someone built an extension?
Regards,
Raashid

[Doxygen-users] how to add coustomized side frame to doxygen html

[sdf <jie...@16...>]

Hi, fiends.

I am using doxygen to generate an API document for my project written in pure C. I want to have a left side frame in the index.html generated by doxygen. So I enabled the option "GENERATE_TREEVIEW" in Doxyfile, but I am not satisfied with its layout.

I want a brief tree layout, not like this :

FilesFileListFileMembersAllFunctions

I have only one file to export, so I don't need "File List".


I have only functions to export(no variables, class etc.), so I don't need "File members".

And, the most reason I want to customize is that I want to classify my API into several different sub-class. Just like this:

CursorOperation
    vi_h()
    vi_j()
    vi_k()
    vi_l()TextEdit
    vi_dw()
    vi_dd()TextSearch
    vi_f()
    vi_F()

But doxygen seems doesn't provide a way to customize the side frame. I have thought about another way: give up side frame, and use an category page, which can be accomplished using \section and @ref. But this is not good for readers, because every time they click, they have to switch to another web-brower tab, slow and inconvenient.

Help me!

[Doxygen-users] Modified search.js

[Alex F. <a....@la...>]

Further to my earlier post "Extending syntax of external searches." I have also modified the file templates/html/extsearch.js to 
modify the format of the output of the search . Again I am posting it here in the hope someone finds it useful.


In "function(data)" :


r+='<tr class="searchresult">'+
            '<td align="right">'+(data.first+i+1)+'.</td>'+
            '<td>  (<span style="font-style:italic;"> <a href="'+escapeHtml(prefix)+'">'+escapeHtml(item.tag)+'</a></span>) 
'+escapeHtml(item.type)+'&#160;'+
                 '<a href="'+escapeHtml(prefix+item.url)+
                 '">'+escapeHtml(item.name)+'</a>';

For each item I include a hyperlink to the top of the package from which the item was found.


and I added a "fail()" method to give a response when doxysearch.cgi returns an error, for example if the wildcard search exceeds 
its limit:

  } else {
       results.html('<p>'+searchResultsText[0]+'</p>');
     }
   })
   .fail(
           function(jqXHR, textStatus, errorThrown){
                   var results = $('#searchresults');
                   var response=jqXHR.responseText;
                   response = response.replace('(','');
                   response = response.replace(')','');
                   results.html('<h1> Your Search Failed</h1> ');
                   var error = JSON.parse(response);
                   results.append(escapeHtml(error.error));
       }
   );
}

[Doxygen-users] Extending syntax of external searches.

[Alex F. <a....@la...>]

Hi,

           I thought I would share this with other doxygen users. I recently moved my site to using "external searching" ( see 
http://www.stack.nl/~dimitri/doxygen/manual/extsearch.html ) . I noticed that the xapian library used by doxygen can provide more 
advance searching than is enabled by default in doxygen, so I modified addon/doxysearch/doxysearch.cpp to take advantage of it. In 
the main routine, I replaced the lines :


>  Xapian::Query query;
>     std::vector<std::string> words = split(searchFor,' ');
>     for (std::vector<std::string>::const_iterator it=words.begin();it!=words.end();++it)
>     {
>           query = Xapian::Query(Xapian::Query::OP_OR,query,Xapian::Query(*it));
>     }

with

> std::vector<std::string> words = split(searchFor,' ');
>     Xapian::QueryParser parser;
>     parser.set_database(db);
>     parser.set_default_op(Xapian::Query::OP_AND);
>     parser.set_stemming_strategy(Xapian::QueryParser::STEM_ALL);
>     Xapian::termcount max_expansion=100;
> //parser.set_max_wildcard_expansion(max_expansion,Xapian::Query::WILDCARD_LIMIT_MOST_FREQUENT);
>     parser.set_max_wildcard_expansion(max_expansion);
>     Xapian::Query query=parser.parse_query(searchFor,Xapian::QueryParser::FLAG_DEFAULT|Xapian::QueryParser::FLAG_WILDCARD);

which gives me "stemmed" searches,  wildcarding, and all terms are ANDed by default . The maximum wildcard expansion doesn't appear 
to work however, but this does not appear to be a problem for me. I have xapian 1.2.22 on my system which is about 18 months old.


Then, to help my users, I modified  src/translator_en.h so that search results include a link to a document describing the available 
search syntax.


> virtual QCString trSearchResults(int numDocuments)
>     {
>         QCString Prompt("<BR> <A HREF=http://mywebserver/QueryParserSyntax.html> See here for details of available search syntax. 
> </A>");
>
>       if (numDocuments==0)
>       {
>         return "Sorry, no documents matching your query."+Prompt;  }
>       else if (numDocuments==1)
>       {
>         return "Found <b>1</b> document matching your query."+Prompt;
>       }
>       else
>       {
>         return "Found <b>$num</b> documents matching your query. Showing best matches first."+Prompt ;
>       }
>     }

I didn't attempt to translate this into all the other 43 available languages however!

The document QueryParserSyntax.html is a modified version of https://xapian.org/docs/queryparser.html with just the parts relevant 
to my setup included.

Hope this helps someone else.

[Doxygen-users] Creating an example using snippet

[Mark <dox...@er...>]

I want to create an example that will appear under “Examples” in the navigation that uses fragments from some of my source files to avoid duplicating that code and having to keep it the duplicates up to date.

My first try was

/** \example test.c */

and in test.c

/** \snippet mysource.c Marker */

This resulted in an empty “test.c” appearing in Examples.

So then I tried, with test.c being an empty file,

/**
\example test.c
\snippet mysource.c Marker
*/

This worked. I got a file test.c in Examples whose content is the snippet. So I got more adventurous:

/**
\example test.c
\dontinclude mysource.c
\skipline foo.h
\skip cbdata {
\until } cbdata
\snippet mysource.c Marker
*/

This worked too. I can’t shake a feeling that I’ve stumbled on a bug that happens to do what I want and so I should not rely on this behavior. Is there a proper way to do this?

If I leave out the \example then the snippet is included in the documentation for whatever is declared following this comment block.

Regards

    -Mark

[Doxygen-users] Code in \code block not included in search.

[alex f. <a....@la...>]

There is a post on this same topic in September 2013, but I can't see a reply.

I have noticed that anything contained within a \code \endcode block is not available for searching. Is this something that can be 
changed in the future?

[Doxygen-users] code in \code \endcode block not included in searches

[Alex F. <a....@la...>]

There is a post on this same topic in September 2013, but I can't see a reply.

I have noticed that anything contained within a \code \endcode block is not available for searching. Is this something that can be 
changed in the future?

Re: [Doxygen-users] Utilizing Doxygen for collaborative document building

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

If the programming language of your project is supported by Doxygen, then Doxygen is a good tool for that. The documentation closely related to code is simply written inside the sources of the code. The extra documentation is written in separate text files with the extension that does not collide with the program sources (say .doc). Then in the Doxyfile (kind of project file for Doxygen) you just include the mask(s) for the extra doc files. In my case it was like:

FILE_PATTERNS          = *.h \
                         *.cpp \
                         *.doc \
                         *.inc

If you know LaTeX, then syntax of the doc files is similar in principle. You just write plain text files with semantic markup (even though visual markup is also possible. You can even combine alternative markup. The Doxygen native markup commands was derived from Javadoc and they are summarized at http://www.doxygen.org/manual/commands.html. If you prefer, you can use Markdown syntax http://www.doxygen.org/manual/markdown.html. You can also use HTML and LaTeX fragments.

The collaboration of more people should be supported by a version control system. The text (that is non-binary) form of document sources is ideal for that kind of work.

P.


From: Molly McAllister [mailto:mol...@uc...]
Sent: Thursday, May 4, 2017 7:27 PM
To: Petr Prikryl <Pri...@sk...>
Cc: dox...@li...
Subject: Re: [Doxygen-users] Utilizing Doxygen for collaborative document building

The document will include the scientific description plus some of the technical code structure (and explanation) of a  model. At the moment it is in pdf format and needs to be updated and edited to include more overview information with graphics as well as code structure, explanation, and snippets. It needs to eventually be hosted on the web, so ultimately html format.  Would doxygen be good for this?

I work on a team and the idea was to have specialists edit their respective sections. So maybe the document would live in doxygen and multiple people could edit it some how.

The other option would be to put the code into doxygen and then document and comment around it.

On Wed, May 3, 2017 at 12:54 AM, Petr Prikryl <Pri...@sk...<mailto:Pri...@sk...>> wrote:
Basically, Doxygen transforms one set of files into another set of files. It was created namely for documenting programming-language source files. It can also be (mis)used for non-programming sources. But there may be better tools for writing just some "text documents" (for example ASCIIDOC). As far as I know, anyone can use Doxygen for free. And as Doxygen only transforms source files to target files, and the collaborators would only write the source files, they do not need to use Doxygen if they do not want. The transformation can be done by someone else. On the other hand, when writing a source file, one would like to check the result occasionally.

Can you describe what kind of "guide document" you want to build?

Doxygen does not solve the collaboration on sources by more people. The key problem of that collaboration is to keep versions and to solve collisions. For that purpose, "version control systems" were designed. And from them I would recommend to use Git (https://git-scm.com/)

Have a nice day,
Petr

-----Original Message-----
From: Molly [mailto:mol...@uc...<mailto:mol...@uc...>]
Sent: Tuesday, May 2, 2017 9:16 PM
To: dox...@li...<mailto:dox...@li...>
Subject: [Doxygen-users] Utilizing Doxygen for collaborative document building

I would like to build and edit a guide document with doxygen. I would like the document to be able to be edited by multiple members on my team. What is the best way to go about this? Does each individual need to have access to doxygen/ license?

Thanks



--
View this message in context: http://doxygen.10944.n7.nabble.com/Utilizing-Doxygen-for-collaborative-document-building-tp7854.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most engaging tech sites, Slashdot.org! http://sdm.link/slashdot _______________________________________________
Doxygen-users mailing list
Dox...@li...<mailto:Dox...@li...>
https://lists.sourceforge.net/lists/listinfo/doxygen-users



--
Molly J. McAllister
mol...@uc...<mailto:mol...@uc...>
office: (303) 497-8253<tel:%28303%29%20497-8404>

Re: [Doxygen-users] Utilizing Doxygen for collaborative document building

[Mark <dox...@er...>]

> On May 5, 2017, at 2:26, Molly McAllister <mol...@uc... <mailto:mol...@uc...>> wrote:
> 
> The document will include the scientific description plus some of the technical code structure (and explanation) of a  model. At the moment it is in pdf format and needs to be updated and edited to include more overview information with graphics as well as code structure, explanation, and snippets. It needs to eventually be hosted on the web, so ultimately html format.  Would doxygen be good for this?
> 
> I work on a team and the idea was to have specialists edit their respective sections. So maybe the document would live in doxygen and multiple people could edit it some how.

I think you’d be better off using Asciidoctor (Asciidoc superset that is actively supported) for this plus the aforementioned git, or other versioning system. You can put code (you do mean source code?) fragments into Asciidoctor and have them syntax highlighted in the output.

Doxygen is for when you want your readers to be able to explore the code structure or get reference information about use of an API.

Regards

   -Mark

Re: [Doxygen-users] Utilizing Doxygen for collaborative document building

[Molly M. <mol...@uc...>]

The document will include the scientific description plus some of the
technical code structure (and explanation) of a  model. At the moment it is
in pdf format and needs to be updated and edited to include more overview
information with graphics as well as code structure, explanation, and
snippets. It needs to eventually be hosted on the web, so ultimately html
format.  Would doxygen be good for this?

I work on a team and the idea was to have specialists edit their respective
sections. So maybe the document would live in doxygen and multiple people
could edit it some how.


The other option would be to put the code into doxygen and then document
and comment around it.

On Wed, May 3, 2017 at 12:54 AM, Petr Prikryl <Pri...@sk...> wrote:

> Basically, Doxygen transforms one set of files into another set of files.
> It was created namely for documenting programming-language source files. It
> can also be (mis)used for non-programming sources. But there may be better
> tools for writing just some "text documents" (for example ASCIIDOC). As far
> as I know, anyone can use Doxygen for free. And as Doxygen only transforms
> source files to target files, and the collaborators would only write the
> source files, they do not need to use Doxygen if they do not want. The
> transformation can be done by someone else. On the other hand, when writing
> a source file, one would like to check the result occasionally.
>
> Can you describe what kind of "guide document" you want to build?
>
> Doxygen does not solve the collaboration on sources by more people. The
> key problem of that collaboration is to keep versions and to solve
> collisions. For that purpose, "version control systems" were designed. And
> from them I would recommend to use Git (https://git-scm.com/)
>
> Have a nice day,
> Petr
>
> -----Original Message-----
> From: Molly [mailto:mol...@uc...]
> Sent: Tuesday, May 2, 2017 9:16 PM
> To: dox...@li...
> Subject: [Doxygen-users] Utilizing Doxygen for collaborative document
> building
>
> I would like to build and edit a guide document with doxygen. I would like
> the document to be able to be edited by multiple members on my team. What
> is the best way to go about this? Does each individual need to have access
> to doxygen/ license?
>
> Thanks
>
>
>
> --
> View this message in context: http://doxygen.10944.n7.
> nabble.com/Utilizing-Doxygen-for-collaborative-document-
> building-tp7854.html
> Sent from the Doxygen - Users mailing list archive at Nabble.com.
>
> ------------------------------------------------------------
> ------------------
> Check out the vibrant tech community on one of the world's most engaging
> tech sites, Slashdot.org! http://sdm.link/slashdot
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>



-- 
Molly J. McAllister
mol...@uc...
office: (303) 497-8253 <%28303%29%20497-8404>

<%28831%29%20261-5149>

[Doxygen-users] man page shows both page name and title. Bug in doxygen?

[Mark <dox...@er...>]

If I have

/** @page toktx
   A description

then the generated man page shows

NAME
    toktx - A description

Nice! Very close to a hand created man pages, except they use 2 hyphens. However if I look at the generated HTML I find the page has the title “$title” and “A description" appears at the top of the page without any heading. If instead I use

/** @page toktx toktx
   A description

then the man page has

NAME
  toktxtoktx - A description

which looks like a bug in Doxygen. Is it? Is there a workaround?

The HTML page now has the title “toktx” and there is heading box at the top of the page with “toktx” in it. “A description” appears below this heading. This is okay except that NAME does not appear so the HTML does not look like the man page.

Regards

    -Mark

[Doxygen-users] Custom command where multiple adjacent are joined into a single "paragraph"

[Mark <dox...@er...>]

I want to create a custom “\error” command that has the exact behavior of \exception (and many others), of joining multiple adjacent occurrences, but prints “Errors” as the section heading.

This exact question (except the wanted text is Options) was asked nearly 6 years on stackoverflow <http://stackoverflow.com/questions/6984927/doxygen-create-custom-command>. The conclusion there is that there is no way to do it except using <li>. Ugh! The OP said he was going to submit a feature request.

It seems unbelievable, given the number of commands that have this joining behavior, that there is no underlying generic command having the behavior that could be used in an ALIAS. If such a thing exists, it has not exactly jumped out at me in special commands. Am I just missing it?

Regards

    -Mark

Re: [Doxygen-users] Utilizing Doxygen for collaborative document building

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

Basically, Doxygen transforms one set of files into another set of files. It was created namely for documenting programming-language source files. It can also be (mis)used for non-programming sources. But there may be better tools for writing just some "text documents" (for example ASCIIDOC). As far as I know, anyone can use Doxygen for free. And as Doxygen only transforms source files to target files, and the collaborators would only write the source files, they do not need to use Doxygen if they do not want. The transformation can be done by someone else. On the other hand, when writing a source file, one would like to check the result occasionally.

Can you describe what kind of "guide document" you want to build?

Doxygen does not solve the collaboration on sources by more people. The key problem of that collaboration is to keep versions and to solve collisions. For that purpose, "version control systems" were designed. And from them I would recommend to use Git (https://git-scm.com/)

Have a nice day,
Petr

-----Original Message-----
From: Molly [mailto:mol...@uc...] 
Sent: Tuesday, May 2, 2017 9:16 PM
To: dox...@li...
Subject: [Doxygen-users] Utilizing Doxygen for collaborative document building

I would like to build and edit a guide document with doxygen. I would like the document to be able to be edited by multiple members on my team. What is the best way to go about this? Does each individual need to have access to doxygen/ license? 

Thanks



--
View this message in context: http://doxygen.10944.n7.nabble.com/Utilizing-Doxygen-for-collaborative-document-building-tp7854.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most engaging tech sites, Slashdot.org! http://sdm.link/slashdot _______________________________________________
Doxygen-users mailing list
Dox...@li...
https://lists.sourceforge.net/lists/listinfo/doxygen-users

[Doxygen-users] Utilizing Doxygen for collaborative document building

[Molly <mol...@uc...>]

I would like to build and edit a guide document with doxygen. I would like
the document to be able to be edited by multiple members on my team. What is
the best way to go about this? Does each individual need to have access to
doxygen/ license? 

Thanks



--
View this message in context: http://doxygen.10944.n7.nabble.com/Utilizing-Doxygen-for-collaborative-document-building-tp7854.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.

[Doxygen-users] How can I get a Functions list in the top level of Doxygen's tree view?

[Mark <dox...@er...>]

I am creating documentation for users of a library. I want to provide info only about functions, data structures, macros, typedefs and what header file they need to include. With Doxygen's standard structure the only way I have been able to coerce it into providing a list of functions is to put \file comment blocks at the top of the header files where they are declared. Doxygen then structures the tree-view  (left-pane) around the files. But API users don't care about how the source is structured.

What I want to do is to place an item called "Functions" in the top level of the ToC in the tree view.

The closest I have come is to create some groups that include the functions. This adds a Modules entry to the tree-view showing the groups I have created and the groups show the functions.

When I add a \files comment block at the top of the public header then the expanded "Files" entry in the tree view shows each file and a "Globals" entry. The contents of the expanded "Globals" entry is ideally what I would like to have at the top level of the tree view: Functions, Macros, Structures, Typedefs, etc.

How can I do this?

Asked also at stackoverflow <http://stackoverflow.com/questions/43629688/how-can-i-get-a-functions-list-in-the-top-level-of-doxygens-tree-view>.

Regards

    -Mark