doxygen-users — List for users of doxygen

[Doxygen-users] Link Requirements to implemented function

[sidharth g. <sid...@ya...>]

Hello, 
I am working on a project which is implemented in C and the requirements are documented.I have managed to create a 'Requirement Implementation' page taking reference from :Custom tags with Doxygen

| 
| 
| 
|  |  |

 |

 |
| 
|  | 
Custom tags with Doxygen

I am trying to figure out if there is a way to create a custom tag using Doxygen. I did find the ALIAS configura...
 |

 |

 |


In the page, it lists all the functions and which requirement they satisfy, which is good.
What I want is a page, in which it lists the Requirements and shows where they are implemented ( preferably, a link to the function)
For example, in the code I have ---
/// @req{req01}FUNC1 (a,b){ ...}/// @req{req02}FUNC2 (e,f){ ...}

/// @req{req01}FUNC3 (c,d){ ...}
What I would like to generate is ---
Req01     Implemented in FUNC1, FUNC3

Req02    Implemented in FUNC2

How can this be done in Doxygen? 


RegardsAwordSid_______________________________________________
Doxygen-users mailing list
Dox...@li...
https://lists.sourceforge.net/lists/listinfo/doxygen-users

[Doxygen-users] How to keep directory struct at external document

[伏田勇也 <no...@gm...>]

Hello.

I want to build documentation by each directory in source tree.
and I integrate top source .

example:
./src/main.cpp
./src/SubA/suba.cpp
./src/SubA/suba.hpp
./src/SubB/subb.cpp
./src/SubB/subb.cpp

DoxyConfFile is :
main.doxy:
     INPUT ./src/main.cpp
     TAGFILES  suba.tag subb.tag

suba.doxy
     INPUT ./src/SubA
    GENERATE_TAGFILE suba.tag

subb.doxy
    INPUT ./src/SubB
    GENERATE_TAGFILE subb.tag

But ," File List" in html document  is broken directory struct in 
sub-directory.

FileList of main.doxy :
src/main.cpp
suba.cpp [external]
suba.hpp[external]
subb.cpp[external]
subb.cpp[external]

I want to following.

src/main.cpp
src/SubA/suba.cpp[external]
src/SubA/suba.hpp[external]
src/SubB/subb.cpp[external]
src/SubB/subb.cpp[external]

So,Please tell me the notes of DoxyConfFile setting.
Doxygen Viersion is 1.8.18.

Regards.

Re: [Doxygen-users] How to get rid of "EXPORT" ... ?

[Andreas F. <and...@ge...>]

#ifndef DOXYGEN_RUNNING

might help

On 7/22/2020 2:22 PM, Richard Damon wrote:
> On 7/22/20 7:49 AM, Harald.Koenig2 via Doxygen-users wrote:
>> Hi *,
>>
>> I'm new to doxygen, using git master branch (cf635ef1) on Ubuntu 18.04
>> (right now mostly with TeXlive 2018 for compatibility by default, TL
>> 2020 installed to).
>>
>> the C sources to be documented (not my own code) uses an "EXPORT" define
>> for some plattforms (e.g. "__declspec(dllexport)" for WIN32):
>>
>> foo.h:
>>
>>      EXPORT int foo(void);
>>
>>
>> and of course this "EXPORT" shows up in doxygen output.
>>
>> question: how to get rid of these "EXPORT"s in doxygen??
>>
>>
>> right I'm using sed to hack the tex files:
>>
>>          sed -i 's/E\\+X\\+P\\+O\\+RT//g'  *.tex
>>
>>
>> there must be a better way??
>>
>>
>> thanks,
>>
>> Harald
>>
> Enable preprocessing (maybe predefined only) and put a define in you
> config file to map EXPORT to nothing. Maybe even you want to also map
> __declspec(x) to nothing too.
>
-- 
Andreas Fabri, PhD
Chief Officer, GeometryFactory
Editor, The CGAL Project

phone: +33.492.954.912    skype: andreas.fabri

[Doxygen-users] Better formatting of enum ?

[Harald.Koenig2 <Har...@bo...>]

Hi again,

I'm new to doxygen, using git master branch (cf635ef1) on Ubuntu 18.04
(right now mostly with TeXlive 2018 for compatibility by default, TL 
2020 installed to).

my 2nd problem/question:
I try to get better formatting for this  enum:

---8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<---

typedef enum {
     BML_API_OK,
     BML_API_ERROR = BML_API_ERROR_BASE,
     BML_API_NOT_INITIALIZED,
     BML_API_CMD_WAIT_TIMEOUT ,
     BML_API_INV_INPUT_PARAM,
     BML_API_CANNOT_RESET_TO_BOOTLOADER,
     BML_API_CANNOT_RESET_TO_FIRMWARE,
     BML_API_BUFF_SIZE_TOO_SMALL,
     BML_API_CANNOT_PROGRAM_INTERNAL_FLASH,
     BML_API_CANNOT_PROGRAM_EXTERNAL_FLASH,
     BML_API_UNKNOWN_FIRMWARE,
     BML_API_INVALID_FIRMWARE_SIGNATURE,
     BML_API_VERSION_NOT_SUPPORTED
} bml_api_error_t;

---8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<---

right now the LaTeX code looks like this with few (random?) \newline
and some lines which stuck way out of the page because those long symbols
are locked in \mbox{} and can't be wrapped around.

---8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<---

\subsection*{Enumerations}
\begin{DoxyCompactItemize}
\item
enum 
\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7}{bml\+\_\+api\+\_\+error\+\_\+t}} 
\{ \newline
\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7a8c291c31524139bc0eef11048dd19470}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+OK}}, 

\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7ab2d7e5f7217c8774f14ff0696fefcf1b}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+E\+R\+R\+OR}} 
= B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+E\+R\+R\+O\+R\+\_\+\+B\+A\+SE,
\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7af9f7835e33297a6934712aea894c07ad}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+N\+O\+T\+\_\+\+I\+N\+I\+T\+I\+A\+L\+I\+Z\+ED}}, 

\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7a536d3800d21e7f060fd496c8c58f6de9}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+C\+M\+D\+\_\+\+W\+A\+I\+T\+\_\+\+T\+I\+M\+E\+O\+UT}}, 

\newline
\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7ad6b598bebe15ea96cb0356c72e2891e7}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+I\+N\+V\+\_\+\+I\+N\+P\+U\+T\+\_\+\+P\+A\+R\+AM}}, 

\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7a44cd19214f24d7f60a110cda79c18026}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+C\+A\+N\+N\+O\+T\+\_\+\+R\+E\+S\+E\+T\+\_\+\+T\+O\+\_\+\+B\+O\+O\+T\+L\+O\+A\+D\+ER}}, 

\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7afda9bf3acf456e6bfaaab278af31e354}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+C\+A\+N\+N\+O\+T\+\_\+\+R\+E\+S\+E\+T\+\_\+\+T\+O\+\_\+\+F\+I\+R\+M\+W\+A\+RE}}, 

\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7ade5f2bdcc4ff538a9b829b3db5dd603b}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+B\+U\+F\+F\+\_\+\+S\+I\+Z\+E\+\_\+\+T\+O\+O\+\_\+\+S\+M\+A\+LL}}, 

\newline
\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7a01fea661a7f72616ce4266c93e76b020}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+C\+A\+N\+N\+O\+T\+\_\+\+P\+R\+O\+G\+R\+A\+M\+\_\+\+I\+N\+T\+E\+R\+N\+A\+L\+\_\+\+F\+L\+A\+SH}}, 

\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7ae08b5ebe3f22c6cce643d25befe66a5f}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+C\+A\+N\+N\+O\+T\+\_\+\+P\+R\+O\+G\+R\+A\+M\+\_\+\+E\+X\+T\+E\+R\+N\+A\+L\+\_\+\+F\+L\+A\+SH}}, 

\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7ac7db5b16f2547ab5b6ba5be26eca73fa}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+U\+N\+K\+N\+O\+W\+N\+\_\+\+F\+I\+R\+M\+W\+A\+RE}}, 

\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7a13999d3062b08173736d61aac7012536}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+I\+N\+V\+A\+L\+I\+D\+\_\+\+F\+I\+R\+M\+W\+A\+R\+E\+\_\+\+S\+I\+G\+N\+A\+T\+U\+RE}}, 

\newline
\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7ae6cc4a6cb870bd8fe2feaede323961c5}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+V\+E\+R\+S\+I\+O\+N\+\_\+\+N\+O\+T\+\_\+\+S\+U\+P\+P\+O\+R\+T\+ED}}
  \}
\end{DoxyCompactItemize}

---8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<---

I've been looking in doxygen sources, but can't find  the place where 
these extra \newline are generated,
and how to get rid of the \mbox{} *only* around those hyperlinks in 
(only this?) enum, asuming that those
\mbox might be helpful and necessary in other places (it's output in 
LatexGenerator::writeObjectLink() which is a pretty generic function).

so right now I'm again using sed to change that TeX code which now looks 
*much* nicer in the PDF output (and nothing's chopped off anymore;)
without the \newline for every entry (just removing \mbox) it's not 
working good either:

---8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<---

sed -i -e '/^\\newline$/d' -e 's/\\newline//'  -e 
's/^\\mbox{\\hyperlink{/\\newline\\mbox{\\hyperlink{/' 
bml__api__error_8h.tex

---8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<---

\subsection*{Enumerations}
\begin{DoxyCompactItemize}
\item
enum 
\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7}{bml\+\_\+api\+\_\+error\+\_\+t}} 
\{
\newline\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7a8c291c31524139bc0eef11048dd19470}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+OK}}, 

\newline\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7ab2d7e5f7217c8774f14ff0696fefcf1b}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+E\+R\+R\+OR}} 
= B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+E\+R\+R\+O\+R\+\_\+\+B\+A\+SE,
\newline\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7af9f7835e33297a6934712aea894c07ad}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+N\+O\+T\+\_\+\+I\+N\+I\+T\+I\+A\+L\+I\+Z\+ED}}, 

\newline\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7a536d3800d21e7f060fd496c8c58f6de9}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+C\+M\+D\+\_\+\+W\+A\+I\+T\+\_\+\+T\+I\+M\+E\+O\+UT}}, 

\newline\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7ad6b598bebe15ea96cb0356c72e2891e7}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+I\+N\+V\+\_\+\+I\+N\+P\+U\+T\+\_\+\+P\+A\+R\+AM}}, 

\newline\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7a44cd19214f24d7f60a110cda79c18026}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+C\+A\+N\+N\+O\+T\+\_\+\+R\+E\+S\+E\+T\+\_\+\+T\+O\+\_\+\+B\+O\+O\+T\+L\+O\+A\+D\+ER}}, 

\newline\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7afda9bf3acf456e6bfaaab278af31e354}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+C\+A\+N\+N\+O\+T\+\_\+\+R\+E\+S\+E\+T\+\_\+\+T\+O\+\_\+\+F\+I\+R\+M\+W\+A\+RE}}, 

\newline\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7ade5f2bdcc4ff538a9b829b3db5dd603b}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+B\+U\+F\+F\+\_\+\+S\+I\+Z\+E\+\_\+\+T\+O\+O\+\_\+\+S\+M\+A\+LL}}, 

\newline\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7a01fea661a7f72616ce4266c93e76b020}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+C\+A\+N\+N\+O\+T\+\_\+\+P\+R\+O\+G\+R\+A\+M\+\_\+\+I\+N\+T\+E\+R\+N\+A\+L\+\_\+\+F\+L\+A\+SH}}, 

\newline\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7ae08b5ebe3f22c6cce643d25befe66a5f}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+C\+A\+N\+N\+O\+T\+\_\+\+P\+R\+O\+G\+R\+A\+M\+\_\+\+E\+X\+T\+E\+R\+N\+A\+L\+\_\+\+F\+L\+A\+SH}}, 

\newline\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7ac7db5b16f2547ab5b6ba5be26eca73fa}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+U\+N\+K\+N\+O\+W\+N\+\_\+\+F\+I\+R\+M\+W\+A\+RE}}, 

\newline\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7a13999d3062b08173736d61aac7012536}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+I\+N\+V\+A\+L\+I\+D\+\_\+\+F\+I\+R\+M\+W\+A\+R\+E\+\_\+\+S\+I\+G\+N\+A\+T\+U\+RE}}, 

\newline\mbox{\hyperlink{bml__api__error_8h_a929ab7cc1948511c2eec61878c68cff7ae6cc4a6cb870bd8fe2feaede323961c5}{B\+M\+L\+\_\+\+A\+P\+I\+\_\+\+V\+E\+R\+S\+I\+O\+N\+\_\+\+N\+O\+T\+\_\+\+S\+U\+P\+P\+O\+R\+T\+ED}}
  \}
\end{DoxyCompactItemize}

---8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<-----8<---



again: there must be a better (non-sed) "doxygen way" to achieve this??

thanks,

Harald

-- 
Mit freundlichen Grüßen / Best regards
*Harald König *
Engineering Optical Systems (BST/EOS2)
Bosch Sensortec GmbH | Gerhard-Kindler-Straße 9 | 72770 Reutlingen | 
GERMANY | _www.bosch-sensortec.com_ <http://www.bosch-sensortec.com>
Tel. +49 7121 35-38606 | Fax +49 711 8115140583 | 
_Harald.Koenig2@bosch-sensortec.com_ 
<mailto:Har...@bo...>
Sitz: Kusterdingen, Registergericht: Stuttgart HRB 382674,
Ust.IdNr. DE 183276693 - Steuer-Nr. 99012/08040
Geschäftsführung: Stefan Finkbeiner, Jens-Knut Fabrowsky

Re: [Doxygen-users] How to get rid of "EXPORT" ... ?

[Harald.Koenig2 <Har...@bo...>]

oops, for the record: I missed that

MACRO_EXPANSION        = YES

must be set, too!


On 7/22/20 3:00 PM, Harald.Koenig2 wrote:

> Hi Richard,
>
> cool, didn't now about "ENABLE_PREPROCESSING" yet.
>
> but it's a bit more complicated (for me;), as ENABLE_PREPROCESSING is 
> already active by default.
> and there is a #define EXPORT <nothing> (which originally was blocked 
> by //\cond IGNORE_DOXYGEN)
>
> when removing IGNORE_DOXYGEN, then that EXPORT shows up in a list of 
> defines,
> and stays in the docs (now in blue) with link to the doc of the empty 
> definition of EXPORT...
>
> BUT with
>
> PREDEFINED             = EXPORT
> EXPAND_ONLY_PREDEF     = YES
>
> in the config file (exactly as you mentioned, now that I found it;) 
> and IGNORE_DOXYGEN it's fine.
>
>
> thanks a lot for your very quick help!!
>
> Harald
>
>
> On 7/22/20 2:22 PM, Richard Damon wrote:
>
>> On 7/22/20 7:49 AM, Harald.Koenig2 via Doxygen-users wrote:
>>> Hi *,
>>>
>>> I'm new to doxygen, using git master branch (cf635ef1) on Ubuntu 18.04
>>> (right now mostly with TeXlive 2018 for compatibility by default, TL
>>> 2020 installed to).
>>>
>>> the C sources to be documented (not my own code) uses an "EXPORT" 
>>> define
>>> for some plattforms (e.g. "__declspec(dllexport)" for WIN32):
>>>
>>> foo.h:
>>>
>>>      EXPORT int foo(void);
>>>
>>>
>>> and of course this "EXPORT" shows up in doxygen output.
>>>
>>> question: how to get rid of these "EXPORT"s in doxygen??
>>>
>>>
>>> right I'm using sed to hack the tex files:
>>>
>>>          sed -i 's/E\\+X\\+P\\+O\\+RT//g'  *.tex
>>>
>>>
>>> there must be a better way??
>>>
>>>
>>> thanks,
>>>
>>> Harald
>>>
>> Enable preprocessing (maybe predefined only) and put a define in you
>> config file to map EXPORT to nothing. Maybe even you want to also map
>> __declspec(x) to nothing too.
>>

Re: [Doxygen-users] How to get rid of "EXPORT" ... ?

[Harald.Koenig2 <Har...@bo...>]

Hi Richard,

cool, didn't now about "ENABLE_PREPROCESSING" yet.

but it's a bit more complicated (for me;), as ENABLE_PREPROCESSING is 
already active by default.
and there is a #define EXPORT <nothing> (which originally was blocked by 
//\cond IGNORE_DOXYGEN)

when removing IGNORE_DOXYGEN, then that EXPORT shows up in a list of 
defines,
and stays in the docs (now in blue) with link to the doc of the empty 
definition of EXPORT...

BUT with

PREDEFINED             = EXPORT
EXPAND_ONLY_PREDEF     = YES

in the config file (exactly as you mentioned, now that I found it;) and 
IGNORE_DOXYGEN it's fine.


thanks a lot for your very quick help!!

Harald


On 7/22/20 2:22 PM, Richard Damon wrote:

> On 7/22/20 7:49 AM, Harald.Koenig2 via Doxygen-users wrote:
>> Hi *,
>>
>> I'm new to doxygen, using git master branch (cf635ef1) on Ubuntu 18.04
>> (right now mostly with TeXlive 2018 for compatibility by default, TL
>> 2020 installed to).
>>
>> the C sources to be documented (not my own code) uses an "EXPORT" define
>> for some plattforms (e.g. "__declspec(dllexport)" for WIN32):
>>
>> foo.h:
>>
>>      EXPORT int foo(void);
>>
>>
>> and of course this "EXPORT" shows up in doxygen output.
>>
>> question: how to get rid of these "EXPORT"s in doxygen??
>>
>>
>> right I'm using sed to hack the tex files:
>>
>>          sed -i 's/E\\+X\\+P\\+O\\+RT//g'  *.tex
>>
>>
>> there must be a better way??
>>
>>
>> thanks,
>>
>> Harald
>>
> Enable preprocessing (maybe predefined only) and put a define in you
> config file to map EXPORT to nothing. Maybe even you want to also map
> __declspec(x) to nothing too.
>

Re: [Doxygen-users] How to get rid of "EXPORT" ... ?

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

On 7/22/20 7:49 AM, Harald.Koenig2 via Doxygen-users wrote:
>
> Hi *,
>
> I'm new to doxygen, using git master branch (cf635ef1) on Ubuntu 18.04
> (right now mostly with TeXlive 2018 for compatibility by default, TL
> 2020 installed to).
>
> the C sources to be documented (not my own code) uses an "EXPORT" define
> for some plattforms (e.g. "__declspec(dllexport)" for WIN32):
>
> foo.h:
>
>     EXPORT int foo(void);
>
>
> and of course this "EXPORT" shows up in doxygen output.
>
> question: how to get rid of these "EXPORT"s in doxygen??
>
>
> right I'm using sed to hack the tex files:
>
>         sed -i 's/E\\+X\\+P\\+O\\+RT//g'  *.tex
>
>
> there must be a better way??
>
>
> thanks,
>
> Harald
>
Enable preprocessing (maybe predefined only) and put a define in you
config file to map EXPORT to nothing. Maybe even you want to also map
__declspec(x) to nothing too.

-- 
Richard Damon

[Doxygen-users] How to get rid of "EXPORT" ... ?

[Harald.Koenig2 <Har...@bo...>]

Hi *,

I'm new to doxygen, using git master branch (cf635ef1) on Ubuntu 18.04
(right now mostly with TeXlive 2018 for compatibility by default, TL 
2020 installed to).

the C sources to be documented (not my own code) uses an "EXPORT" define
for some plattforms (e.g. "__declspec(dllexport)" for WIN32):

foo.h:

     EXPORT int foo(void);


and of course this "EXPORT" shows up in doxygen output.

question: how to get rid of these "EXPORT"s in doxygen??


right I'm using sed to hack the tex files:

         sed -i 's/E\\+X\\+P\\+O\\+RT//g'  *.tex


there must be a better way??


thanks,

Harald

-- 

Mit freundlichen Grüßen / Best regards
*Harald König *
Engineering Optical Systems (BST/EOS2)
Bosch Sensortec GmbH | Gerhard-Kindler-Straße 9 | 72770 Reutlingen | 
GERMANY | _www.bosch-sensortec.com_ <http://www.bosch-sensortec.com>
Tel. +49 7121 35-38606 | Fax +49 711 8115140583 | 
_Harald.Koenig2@bosch-sensortec.com_ 
<mailto:Har...@bo...>
Sitz: Kusterdingen, Registergericht: Stuttgart HRB 382674,
Ust.IdNr. DE 183276693 - Steuer-Nr. 99012/08040
Geschäftsführung: Stefan Finkbeiner, Jens-Knut Fabrowsky

Re: [Doxygen-users] Turn off syntax highlighting in fenced code blocks

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

I looked at the Doxygen code and discovered that a fenced code block in a Markdown file is converted to @code … @endcode block before further processing. I have also discovered that @code{.unparsed} in a .cpp file results in the same “hljs” syntax highlighting. Is this a bug in doxygen or something undocumented? The documentation quite clearly states
"If the contents of the code block are in a language that doxygen cannot parse, doxygen will just show the output as-is. You can make this explicit using .unparsed, or by giving some other extension that doxygen doesn't support, e.g.

  \code{.unparsed}
  Show this as-is please
  \endcode
“

Regards

    -Mark

> On Jul 20, 2020, at 14:30, Mark <dox...@er...> wrote:
> 
> No, sadly that doesn’t work either. Nor does ```unparsed.
> 
> doxygen seems to think these blocks are some language called hljs. This is the HTML for the example I gave below:
> 
> code class="fragment <>"><span class="hljs-selector-tag <>">Support</span> 16<span class="hljs-selector-tag <>">-bit</span> <span class="hljs-selector-tag <>">and</span> <span class="hljs-selector-tag <>">paletted</span> <span class="hljs-selector-tag <>">images</span>.
> <span class="hljs-selector-tag <>">Fixes</span> <span class="hljs-selector-id <>">#252</span>. <span class="hljs-selector-tag <>">Fixes</span> <span class="hljs-selector-id <>">#253</span>. <span class="hljs-selector-tag <>">Fixes</span> <span class="hljs-selector-id <>">#255</span>.
> </code></pre></div>
> Regards
> 
>     -Mark
> 
>> On Jul 20, 2020, at 14:08, Travis Everett <tra...@gm... <mailto:tra...@gm...>> wrote:
>> 
>> Drat. I know that works for some other markdown-based systems I use.
>> 
>> I found a mention in the docs for the \code command (https://www.doxygen.nl/manual/commands.html#cmdcode <https://www.doxygen.nl/manual/commands.html#cmdcode>) that mention using `{.unparsed}` to explicitly specify blocks like this. If the Markdown equivalent is flowing through the same code site, perhaps that'll work?
>> 
>> On Mon, Jul 20, 2020 at 3:55 PM Mark <dox...@er... <mailto:dox...@er...>> wrote:
>> 
>> Thanks for the suggestion. No it does not. I tried ```plain, ```.plain ```{plain} and ```{.plain}. None had any effect.
>> 
>> I’ve also discovered that \verbatim is doing the same highlighting.
>> 
>> For example the text
>> 
>> Support 16-bit and paletted images
>> .
>> 
>> Fixes #252. Fixes #253. Fixes #255.
>> 
>> is rendered with everything but “16” in boldface and the numbers after Fixes rendered in red.
>> 
>> Regards
>> 
>>     -Mark
>> 
>> 
>>> On Jul 20, 2020, at 13:27, Travis Everett <tra...@gm... <mailto:tra...@gm...>> wrote:
>>> 
>>> Does `plain` work?
>>> 
>>> On Mon, Jul 20, 2020 at 3:04 PM Mark <dox...@er... <mailto:dox...@er...>> wrote:
>>> I have a fenced code block
>>> 
>>> ```
>>> Text that is not code
>>> ```
>>> 
>>> and it is being highlighted. How can I prevent that? I tried ```text and ```plaintext, ```{.text} and ```{.txt} but none made any difference.
>>> 
>>> Regards
>>> 
>>>     -Mark
>>> 
>>> _______________________________________________
>>> Doxygen-users mailing list
>>> Dox...@li... <mailto:Dox...@li...>
>>> https://lists.sourceforge.net/lists/listinfo/doxygen-users <https://lists.sourceforge.net/lists/listinfo/doxygen-users>
>> 
> 

[Doxygen-users] Turn off syntax highlighting in fenced code blocks

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

I have a fenced code block

```
Text that is not code
```

and it is being highlighted. How can I prevent that? I tried ```text and ```plaintext, ```{.text} and ```{.txt} but none made any difference.

Regards

    -Mark

[Doxygen-users] Latex compile issue

[Bleier, L. Z. (GSFC-5820) <leo...@na...>]

Hi all,
I am not sure if this a bug or just incorrect usage on my part:

I tell doxygen to generate latex, but during compilation of those files using pdflatex I get stopped at lines containing doxyparagraph. For example, with a line like this in the .tex file:

\begin{center}\doxyparagraph*{Modifying a registered event message filter }\end{center}

I get the following error:

! LaTeX Error: Something's wrong--perhaps a missing \item.

See the LaTeX manual or LaTeX Companion for explanation.
Type  H <return>  for immediate help.
...                                              

l.124 ...stered event message filter }\end{center}

I don't see any obvious problem with the line. I will note that this does *not* seem to occur with doxysubsection.

Am I doing something wrong? Or could this be a bug?

Thanks,
Leor

-------------------------
Leor Bleier
Computer Engineer
NASA Goddard Space Flight Center
Flight Software Systems Branch – Code 582
Greenbelt, MD 20771
P: 301-286-6634
F: 301-286-1768

[Doxygen-users] Markdown table alignment information in XML output

[Leonardo P. S. <Leo...@on...>]

Hi All!

I'm working on a parser for Doxygen's XML output and I have a question about where in the XML output I can find the alignment information of a Markdown table.

Let's say that I have this example function:


/**
* This is a simple function.
*
* This function showcases how to document a very simple function. It also
* shows that detailed descriptions can have Markdown elements like tables:
*
* | Left aligned   | Center Aligned    | Right Aligned     |
* |:---------------|:-----------------:|------------------:|
* | tableA         | tableB            | tableC            |
* | tableE         | tableF            | tableG            |
*
* @param[in] i Input value.
*/
void test_function(int i);


The relevant XML data for the table is:


<para><table rows="3" cols="3"><row>
<entry thead="yes"><para>Left aligned  </para>
</entry><entry thead="yes"><para>Center Aligned  </para>
</entry><entry thead="yes"><para>Right Aligned   </para>
</entry></row>
<row>
<entry thead="no"><para>tableA  </para>
</entry><entry thead="no"><para>tableB  </para>
</entry><entry thead="no"><para>tableC   </para>
</entry></row>
<row>
<entry thead="no"><para>tableE  </para>
</entry><entry thead="no"><para>tableF  </para>
</entry><entry thead="no"><para>tableG   </para>
</entry></row>
</table>
</para>


I can't find the alignment information anywhere. The HTML output does preserve the alignment:


<table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadLeft">Left aligned  </th><th class="markdownTableHeadCenter">Center Aligned  </th><th class="markdownTableHeadRight">Right Aligned   </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyLeft">tableA  </td><td class="markdownTableBodyCenter">tableB  </td><td class="markdownTableBodyRight">tableC   </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyLeft">tableE  </td><td class="markdownTableBodyCenter">tableF  </td><td class="markdownTableBodyRight">tableG   </td></tr>
</table>


How can I get the alignment information from the XML output?

Thank you very much!

Leonardo Pereira Santos | ON Semiconductor
Design Engineer

200-611 Kumpf Dr        | Waterloo, Ontario, Canada, N2N 1A8
519-884-9696 x2269 (O)  | Leo...@on...<mailto:Leo...@on...>

[Doxygen-users] Generate filenames without Version supported?

[Roland P. <ro...@rp...>]

I've got a problem with generated doxygen files. I'm linking directly to
the class files in my Wiki. The problem is the filenames contain version
number like this:

classDragengine_1_2Scenery_1_2ECBehaviorInteractPrompt.html

So the verion "1.2" is encoded in the URL. Now if I upgrade the version
and regenerate the documentation then the URL changes and all the
existing wiki page links break.

Is there a way in doxygen to generated class files without version
number encoded?

Or is it possible to use some kind of "entry page" to tell with a
parameter which class to display?

-- 
Yours sincerely
Plüss Roland

Game Development and Game Engine Technologies https://dragondreams.ch

Re: [Doxygen-users] Doxygen-users Digest, Vol 167, Issue 5

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

On Sun, Jun 14, 2020 at 8:04 AM <dox...@li...>
wrote:

> Date: Sat, 13 Jun 2020 15:38:43 -0700
> From: Mark <dox...@er...>
> Subject: [Doxygen-users] Generating man pages *only* for functions
>
> I am documenting the API of a library and generate HTML and man pages.
> Unfortunately it generates man pages for every structure and every field of
> every structure so the man 3 directory gets polluted with files like
> height.3 containing the man page for a field of a struct called height.
>
> Is there a way to get Doxygen to generate man pages only for the
> documented functions and stop this crazy pollution? Ideally these man pages
> would contain the documentation for any structures used in the function?s
> API. If I can?t solve this I will not be able to ship the man pages with
> the software.
>

Sounds like you have  EXTRACT_ALL turned on (see:
https://www.doxygen.nl/manual/config.html#cfg_extract_all)

If you turn that off, Doxygen will only generate documentation for
documented things. HOWEVER, it will complain about undocumented things.

There is  \internal and  \endinternal to designate ranges that should only
be included when INTERNAL_DOCS is on. (see:
https://www.doxygen.nl/manual/commands.html#cmdinternal)

[Doxygen-users] Generating man pages *only* for functions

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

I am documenting the API of a library and generate HTML and man pages. Unfortunately it generates man pages for every structure and every field of every structure so the man 3 directory gets polluted with files like height.3 containing the man page for a field of a struct called height.

Is there a way to get Doxygen to generate man pages only for the documented functions and stop this crazy pollution? Ideally these man pages would contain the documentation for any structures used in the function’s API. If I can’t solve this I will not be able to ship the man pages with the software.

Regards

    -Mark

[Doxygen-users] Change Doxygen comment signs

[mabbi <ma...@st...>]

Hello,
I've to generate some documentation about hundred of xml files in many
folders, witch are commented like <!--  commenttext  -->.
Is there a way to use doxygen as generator?

Greetings
Marc

[Doxygen-users] Generated docset missing "docSet.dsidx" database

[Lorenzo C. <lor...@gm...>]

Hi everyone,

I am trying to generate a valid docset on Linux/Ubuntu, but it seems the
output
is missing the SQLlite database. I known that doxygen requires the
`docsetutil`
utility (provided only with Xcode); is that program responsible for
setting up
the database? And if yes, does doxygen provide any alternative to generate a
valid docset on Linux/Ubuntu?

I am using Doxygen ver. 1.8.14, but I also tried with ver. 1.8.4.

Thank you!


Best regards,
Lorenzo Casalino

[Doxygen-users] Distributed pages in doxygen

[Carsten S. <ca...@fa...>]

Hi,

in one of my projects I would like to build pages based on doxygen 
blocks that are distributed among several source code files. The page 
shall document shell commands in an embedded setup.

Example:

file1.cpp:

/** Documentation of "ps" shell command */
SHELL_COMMAND("ps", somestuff)

/** Documentation of "ls" shell command */
SHELL_COMMAND("ls", someotherstuff)

file2.cpp:

/** Documentation of "w" shell command */
SHELL_COMMAND("w", morestuff)


I would like to have all these three documentation blocks on one page 
(order does not matter). When dealing with sections/modules I can do it 
using \addtosection or \ingroup but I did not find anything similar for 
pages. Is there any way to archieve that?

I've already tried to define the same page name multiple times but it 
results in strange behaviour (headings appearing multiple times and mess 
up).

Best regards,
Carsten

[Doxygen-users] PlantUML on reverse source code automatic generated Collaboration Graphs

[Ricardo M. <ric...@gm...>]

Hello,

I have a doubt regarding the PlantUML support on Doxygen. I apologize if
this has already been answered but I tried to look documentation / mailing
list / GitHub issues without a clear answer to my question...
I'd like to ask if Doxygen supports the generation of Collaboration Graphs,
provided by the automatic reverse source code transversal, using the
PlantUML looks/backend instead of the default GraphViz/Dot looking ones?
And in case it does support this feature, how can I accomplish it?

Thank you for your attention. Regards,

-- 

Ricardo Mota

Re: [Doxygen-users] How to configure Doxygen to generate individual classes list for a single project (if there are many related projects)

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

At 11:37 19.05.2020, Сергей Степанов wrote:

>> Why don't you create the documentation for each directory separately
>> and create a main page with the links yourself? That is, if there aren't
>> any cross links between the directories.
>
>Look at the list of projects. There is, for example, an IDK (analogue
>SDK). Therefore, links between projects are necessary. What to do in
>this case?

Please keep it on the list.

You can probably achieve this with tag files.
http://www.doxygen.nl/manual/external.html

bye  Fabi

Re: [Doxygen-users] How to configure Doxygen to generate individual classes list for a single project (if there are many related projects)

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

At 10:33 19.05.2020, Сергей Степанов wrote:
>I have several C ++ projects related to each other. The project code
>is something like this:
>
>----- 8< -----
>/main/src
>/idk/src
>/device_module/device1/src
>/device_module/device50/src
>/control_panel/src
>/logging/src
>...
>/doxygen_documentation <----- Here is Doxyfile, here Doxygen running
>----- 8< -----
>
>I need to generate documentation so that the title page contains links
>to projects, and on the project pages there is a list of only those
>classes that relate to the current project. But at this time, Doxygen
>generate big heap with all clesses from all projects directories.
>
>How to configure the program as I need?

Why don't you create the documentation for each directory separately
and create a main page with the links yourself? That is, if there aren't
any cross links between the directories.

bye  Fabi

[Doxygen-users] How to remove multiple “readme” lines from Related Pages tab?

[Сергей С. <xi...@gm...>]

I am using Doxygen 1.8.13 at Linux Debian 9.

I have several readme.md files. Each readme.md file locate at
subdirectory (over ~10 projects). I am trying to generate overall
documentation for my projects.

Any file readme.md have structure:

----- 8< -----
//! @page project_name Project name
About project...
----- 8< -----

For each readme.md, on Related Pages tab, Doxygen generate line
"readme" and line with project name. And this list of links looks like
this:

----- 8< -----
readme
readme
readme
readme
Project name one
Project name two
Project name three
Project name four
----- 8< -----

If click at any "readme" line, i see text: "//!".

The URLs for this "readme"-links is:

----- 8< -----
..._project_name_one_src_readme.html

..._project_name_four_src_readme.html
----- 8< -----

Question: how to remove this strange "readme" lines?


-- 
Best regards, Sergey M. Stepanov
http://webhamster.ru

[Doxygen-users] How to configure Doxygen to generate individual classes list for a single project (if there are many related projects)

[Сергей С. <xi...@gm...>]

I have several C ++ projects related to each other. The project code
is something like this:

----- 8< -----
/main/src
/idk/src
/device_module/device1/src
/device_module/device50/src
/control_panel/src
/logging/src
...
/doxygen_documentation <----- Here is Doxyfile, here Doxygen running
----- 8< -----

Options in Doxyfile:

----- 8< -----
INPUT = . \
 ../main/src \
 ../idk/src \
 ../device_module/device1/src \
 ../device_module/device50/src \
 ../control_panel/src \
 ../logging/src

SEPARATE_MEMBER_PAGES=YES
----- 8< -----

I need to generate documentation so that the title page contains links
to projects, and on the project pages there is a list of only those
classes that relate to the current project. But at this time, Doxygen
generate big heap with all clesses from all projects directories.

How to configure the program as I need?


-- 
Best regards, Sergey M. Stepanov
http://webhamster.ru

[Doxygen-users] Is there a way to disable markdown and lists?

[André H. <an...@we...>]

I would like to get the raw docblock in the XML output. I tried setting
MARKDOWN_SUPPORT = NO, but as far as I can see it doesn't change anything.

The docblock is for example:

/**
 * Helper to update a single bit of an A/B register.
 * - Reads the current register value
 * - Writes the new register value
 */

This becomes this XML output:

<para>Helper to update a single bit of an A/B register.<itemizedlist>
<listitem><para>Reads the current register value</para>
</listitem><listitem><para>Writes the new register value </para>
</listitem></itemizedlist>
</para>

I'm not sure if this is a markdown feature or a separate step, but I would
like to completely disable the parsing of the "- " into "<listitem>", I
would like the docblock as raw as possible. Is there an option for that?

[Doxygen-users] Fwd: parsing openscad files

[Bruno B. <bb...@gm...>]

Hello
i would like to document a project of openscad files, i had a, scary, look
at scanner.l and am wondering if its possible to adapt doxygen to parse
also openscad files?

since it parses c it shouldn't be too hard, i am perfectly fine with
javadoc style comments, and the only structure that need parsing are
functions and modules....

functions look like this:
keyword:function name (arguments, ev with default vals) = the function code;
e.g.
function tighten (angle=90) = [0,0,-1*angle];

modules called subs:
keyword: module(arguments, ev with default val) { sub code }

e.g.

module hex (width=10, height=10, flats= true, center=false){
  radius= (flats == true ? width/sin(60)/2 : width/2 );
    cylinder (r=radius, h=height, center=center, $fn=6);
}

to make it perfect, but that one probably will be much harder, usually
there are settings vars at the beginning of a file which could need to be
documented too, but that one is low priority.... if already it was possible
to extract all javadoc, all functions and modules and join the javadoc or
create an empty doc stub, that would be great....

so what do i need to do, to achieve this? as sayd, i looked at scanner.l,
but didn't understand anything about it :(

-- 
ciao
Bruno

===========================================
http://nohkumado.eu/, <http://bboett.free.fr>http://aikido.nohkumado.eu/,
<http://bboett.free.fr>
http://aikido.zorn.free.fr