doxygen-users Mailing List for Doxygen (Page 49)
Brought to you by:
dimitri
Menu
▾
▴
doxygen-users — List for users of doxygen
You can subscribe to this list here.
| 2001 |
Jan
|
Feb
|
Mar
|
Apr
(1) |
May
(118) |
Jun
(150) |
Jul
(115) |
Aug
(75) |
Sep
(92) |
Oct
(102) |
Nov
(139) |
Dec
(87) |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2002 |
Jan
(131) |
Feb
(60) |
Mar
(114) |
Apr
(83) |
May
(125) |
Jun
(82) |
Jul
(95) |
Aug
(98) |
Sep
(109) |
Oct
(97) |
Nov
(72) |
Dec
(70) |
| 2003 |
Jan
(117) |
Feb
(122) |
Mar
(187) |
Apr
(114) |
May
(154) |
Jun
(131) |
Jul
(130) |
Aug
(98) |
Sep
(121) |
Oct
(107) |
Nov
(80) |
Dec
(54) |
| 2004 |
Jan
(78) |
Feb
(71) |
Mar
(118) |
Apr
(56) |
May
(56) |
Jun
(64) |
Jul
(164) |
Aug
(104) |
Sep
(101) |
Oct
(69) |
Nov
(107) |
Dec
(98) |
| 2005 |
Jan
(75) |
Feb
(77) |
Mar
(107) |
Apr
(114) |
May
(142) |
Jun
(106) |
Jul
(79) |
Aug
(108) |
Sep
(115) |
Oct
(140) |
Nov
(128) |
Dec
(63) |
| 2006 |
Jan
(86) |
Feb
(71) |
Mar
(125) |
Apr
(55) |
May
(48) |
Jun
(143) |
Jul
(99) |
Aug
(91) |
Sep
(93) |
Oct
(82) |
Nov
(46) |
Dec
(45) |
| 2007 |
Jan
(69) |
Feb
(97) |
Mar
(125) |
Apr
(112) |
May
(65) |
Jun
(80) |
Jul
(82) |
Aug
(84) |
Sep
(56) |
Oct
(74) |
Nov
(63) |
Dec
(74) |
| 2008 |
Jan
(161) |
Feb
(115) |
Mar
(58) |
Apr
(73) |
May
(58) |
Jun
(79) |
Jul
(57) |
Aug
(115) |
Sep
(79) |
Oct
(62) |
Nov
(93) |
Dec
(37) |
| 2009 |
Jan
(69) |
Feb
(115) |
Mar
(77) |
Apr
(85) |
May
(124) |
Jun
(58) |
Jul
(44) |
Aug
(85) |
Sep
(90) |
Oct
(80) |
Nov
(87) |
Dec
(48) |
| 2010 |
Jan
(52) |
Feb
(71) |
Mar
(54) |
Apr
(37) |
May
(66) |
Jun
(86) |
Jul
(84) |
Aug
(68) |
Sep
(94) |
Oct
(66) |
Nov
(36) |
Dec
(53) |
| 2011 |
Jan
(59) |
Feb
(77) |
Mar
(59) |
Apr
(67) |
May
(76) |
Jun
(54) |
Jul
(95) |
Aug
(92) |
Sep
(84) |
Oct
(72) |
Nov
(46) |
Dec
(60) |
| 2012 |
Jan
(43) |
Feb
(77) |
Mar
(88) |
Apr
(121) |
May
(81) |
Jun
(69) |
Jul
(97) |
Aug
(64) |
Sep
(55) |
Oct
(55) |
Nov
(38) |
Dec
(60) |
| 2013 |
Jan
(85) |
Feb
(70) |
Mar
(81) |
Apr
(83) |
May
(51) |
Jun
(65) |
Jul
(71) |
Aug
(39) |
Sep
(47) |
Oct
(32) |
Nov
(43) |
Dec
(28) |
| 2014 |
Jan
(64) |
Feb
(22) |
Mar
(54) |
Apr
(20) |
May
(59) |
Jun
(20) |
Jul
(50) |
Aug
(17) |
Sep
(37) |
Oct
(56) |
Nov
(40) |
Dec
(24) |
| 2015 |
Jan
(51) |
Feb
(29) |
Mar
(57) |
Apr
(31) |
May
(23) |
Jun
(50) |
Jul
(30) |
Aug
(66) |
Sep
(59) |
Oct
(21) |
Nov
(29) |
Dec
(12) |
| 2016 |
Jan
(33) |
Feb
(30) |
Mar
(19) |
Apr
(23) |
May
(16) |
Jun
(31) |
Jul
(17) |
Aug
(19) |
Sep
(21) |
Oct
(20) |
Nov
(15) |
Dec
(6) |
| 2017 |
Jan
(16) |
Feb
(13) |
Mar
(16) |
Apr
(23) |
May
(16) |
Jun
(5) |
Jul
(14) |
Aug
(13) |
Sep
(12) |
Oct
(11) |
Nov
(3) |
Dec
(6) |
| 2018 |
Jan
(4) |
Feb
(6) |
Mar
(5) |
Apr
(11) |
May
(26) |
Jun
(5) |
Jul
(10) |
Aug
(7) |
Sep
(3) |
Oct
|
Nov
(3) |
Dec
(7) |
| 2019 |
Jan
(17) |
Feb
(18) |
Mar
(5) |
Apr
(6) |
May
(3) |
Jun
|
Jul
(9) |
Aug
(19) |
Sep
(3) |
Oct
(1) |
Nov
(23) |
Dec
(5) |
| 2020 |
Jan
(7) |
Feb
(1) |
Mar
(7) |
Apr
(11) |
May
(8) |
Jun
(7) |
Jul
(10) |
Aug
(3) |
Sep
(4) |
Oct
(7) |
Nov
(6) |
Dec
|
| 2021 |
Jan
(3) |
Feb
|
Mar
(4) |
Apr
(4) |
May
|
Jun
|
Jul
(1) |
Aug
(3) |
Sep
|
Oct
|
Nov
(8) |
Dec
(3) |
| 2022 |
Jan
(2) |
Feb
|
Mar
(1) |
Apr
|
May
(3) |
Jun
(1) |
Jul
|
Aug
(3) |
Sep
(9) |
Oct
(2) |
Nov
|
Dec
(2) |
| 2023 |
Jan
(2) |
Feb
(5) |
Mar
(3) |
Apr
(7) |
May
(6) |
Jun
(2) |
Jul
(5) |
Aug
|
Sep
(4) |
Oct
(1) |
Nov
(5) |
Dec
(5) |
| 2024 |
Jan
|
Feb
|
Mar
|
Apr
|
May
(3) |
Jun
(4) |
Jul
|
Aug
(3) |
Sep
|
Oct
|
Nov
(1) |
Dec
|
|
From: Alessandro A. <ant...@gm...> - 2015-01-17 15:35:50
|
Hi, all.
Thanks for the answers.
Albert. The file extension is '.md' and it is already mapped in the
'doxyfile'
configuration file. The file has 343 lines and is parsed Ok. The only
problem
is the headings that are not rendered as <h2> tags as it should be.
Hi, Christoph Lipka. I didn't understand your answer. My file is a Markdown
file. How can I put a '@subsection' inside it? Or are you suggesting to
change
the entire file to Doxygen markup?
2015-01-17 12:23 GMT-02:00 Christoph Lipka <chr...@li...>:
> Am 17.01.2015 um 14:49 schrieb Alessandro Antonello:
>
> I am using doxygen 1.8.9.1 under Cygwin in a Windows 7 64 bits and I'm
> having
> difficulties to generate the main page of a C library in Markdown. The
> problematic piece of text follows:
>
> ~~~~~~~~~~~~
> The following pages have more comments and important notes on this library.
>
> - [Macros](#macrospage)
> - [Functions](#functionspage)
> - [Formated Strings](#printfformat)
> - [Formated Scanning](#scanfformat)
> - [Time Formating](#timeformat)
>
> Function Macros {#macrospage}
> ------------------------------------
>
>
> I've been having trouble with this type of headings, too, and am now using
> "@section" and "@subsection" instead, as in:
>
> @subsection macrospage Function Macros
>
>
>
> ------------------------------------------------------------------------------
> New Year. New Location. New Benefits. New Data Center in Ashburn, VA.
> GigeNET is offering a free month of service with a new server in Ashburn.
> Choose from 2 high performing configs, both with 100TB of bandwidth.
> Higher redundancy.Lower latency.Increased capacity.Completely compliant.
> http://p.sf.net/sfu/gigenet
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>
|
|
From: Christoph L. <chr...@li...> - 2015-01-17 14:36:23
|
Am 17.01.2015 um 14:49 schrieb Alessandro Antonello:
> I am using doxygen 1.8.9.1 under Cygwin in a Windows 7 64 bits and I'm
> having
> difficulties to generate the main page of a C library in Markdown. The
> problematic piece of text follows:
>
> ~~~~~~~~~~~~
> The following pages have more comments and important notes on this
> library.
>
> - [Macros](#macrospage)
> - [Functions](#functionspage)
> - [Formated Strings](#printfformat)
> - [Formated Scanning](#scanfformat)
> - [Time Formating](#timeformat)
>
> Function Macros {#macrospage}
> ------------------------------------
I've been having trouble with this type of headings, too, and am now
using "@section" and "@subsection" instead, as in:
@subsection macrospage Function Macros
|
|
From: Albert <alb...@gm...> - 2015-01-17 14:04:46
|
Hi Allessandro,
What is the extension of the file you want to include?
In case .c or .cpp etc it might miss /** etc. In case of another
extension, maybe EXTENSION_MAPPING to md might help.
Albert
On Sat, Jan 17, 2015 at 2:49 PM, Alessandro Antonello <
ant...@gm...> wrote:
> Hi, everyone.
>
> I am using doxygen 1.8.9.1 under Cygwin in a Windows 7 64 bits and I'm
> having
> difficulties to generate the main page of a C library in Markdown. The
> problematic piece of text follows:
>
> ~~~~~~~~~~~~
> The following pages have more comments and important notes on this library.
>
> - [Macros](#macrospage)
> - [Functions](#functionspage)
> - [Formated Strings](#printfformat)
> - [Formated Scanning](#scanfformat)
> - [Time Formating](#timeformat)
>
> Function Macros {#macrospage}
> ------------------------------------
>
> Following standard naming conventions ...
> ~~~~~~~~~~~~
>
> As you can see I'm just list some items linked with sections in the same
> file.
> Despite that the link part is processed and rendered Ok (the <li> element
> has
> an anchor tag <a href="#macrospace">) the section "Function Macros" (and
> all
> others) are not rendered in the final HTML. They are simply gone.
>
> I tried the section creation with the syntax above and also with the
> sharped
> syntax accepted by Mardown, as shown below:
>
> ~~~~~~~~~~~~
> ## Function Macros ## {#macrospage}
> ~~~~~~~~~~~~
>
> And I also tried without the ending sharps:
>
> ~~~~~~~~~~~~
> ## Function Macros {#macrospage}
> ~~~~~~~~~~~~
>
> None of them rendered the final HTML correctly. Am I doing something wrong?
>
> I also installed the Windows native version of Doxygen (1.8.9.1) and got
> the
> same result.
>
> Anyone has this issue either?
>
>
>
> ------------------------------------------------------------------------------
> New Year. New Location. New Benefits. New Data Center in Ashburn, VA.
> GigeNET is offering a free month of service with a new server in Ashburn.
> Choose from 2 high performing configs, both with 100TB of bandwidth.
> Higher redundancy.Lower latency.Increased capacity.Completely compliant.
> http://p.sf.net/sfu/gigenet
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>
|
|
From: Alessandro A. <ant...@gm...> - 2015-01-17 13:50:24
|
Hi, everyone.
I am using doxygen 1.8.9.1 under Cygwin in a Windows 7 64 bits and I'm
having
difficulties to generate the main page of a C library in Markdown. The
problematic piece of text follows:
~~~~~~~~~~~~
The following pages have more comments and important notes on this library.
- [Macros](#macrospage)
- [Functions](#functionspage)
- [Formated Strings](#printfformat)
- [Formated Scanning](#scanfformat)
- [Time Formating](#timeformat)
Function Macros {#macrospage}
------------------------------------
Following standard naming conventions ...
~~~~~~~~~~~~
As you can see I'm just list some items linked with sections in the same
file.
Despite that the link part is processed and rendered Ok (the <li> element
has
an anchor tag <a href="#macrospace">) the section "Function Macros" (and all
others) are not rendered in the final HTML. They are simply gone.
I tried the section creation with the syntax above and also with the sharped
syntax accepted by Mardown, as shown below:
~~~~~~~~~~~~
## Function Macros ## {#macrospage}
~~~~~~~~~~~~
And I also tried without the ending sharps:
~~~~~~~~~~~~
## Function Macros {#macrospage}
~~~~~~~~~~~~
None of them rendered the final HTML correctly. Am I doing something wrong?
I also installed the Windows native version of Doxygen (1.8.9.1) and got the
same result.
Anyone has this issue either?
|
|
From: borsto <bor...@ac...> - 2015-01-15 16:36:06
|
.. try a custom command: http://www.stack.nl/~dimitri/doxygen/manual/custcmd.html > I would like to force the command *snippet* to indicate where is the > source > file used to extract the code: is that possible to do so ? ----- 1. when you hold a hammer, everything looks like a nail. 2. a screw, hammered in, holds better than a nail installed with a screwdriver. -- View this message in context: http://doxygen.10944.n7.nabble.com/Snippet-indicate-where-is-the-source-file-tp6982p6983.html Sent from the Doxygen - Users mailing list archive at Nabble.com. |
|
From: Vincent H. <vin...@ce...> - 2015-01-15 14:23:09
|
Dear all, I would like to force the command *snippet* to indicate where is the source file used to extract the code: is that possible to do so ? All the best, VH. -- CeMoSiS <http://www.cemosis.fr> - vin...@ce... Tel: +33 (0)3 68 8*5 02 06* IRMA - 7, rue René Descartes 67 000 Strasbourg |
|
From: Albert <alb...@gm...> - 2015-01-14 13:24:17
|
Hi Torsten,
Did some tests but could not figure out what went wrong must be some subtle
interaction between EXPAND_AS_DEFINED and EXPAND_ONLY_PREDEF that I,
unfortunately didn't figure out.
Note: for other readers the example as provided the description of the
Doxyfile in the original posting is not conforming the attached Doxyfiles
but the attached Doxyfiles show the observed phenomena.
Albert
On Wed, Jan 14, 2015 at 12:49 PM, Torsten Hees <A1...@gm...> wrote:
> Hello Albert,
>
> I use the current version for windows on windows7 64bit (1.8.9.1).
>
> I added 4 files:
> Image: The image shows the correct generated page and the not correct
> generated
> Doxygenfiles
> Headerfile
>
> The doxygenfile ending on "working" use the MACRO_EXPANSION feature. In
> this case the page is correct (see image left side).
> The doxygenfile ending on "NotWorking" use the MACRO_EXPANSION feature +
> EXPAND_ONLY_PREDEF feature. In this case html side is not correct generated
> (see image right side).
>
> Best regards
> Torsten
>
> *Gesendet:* Mittwoch, 14. Januar 2015 um 10:59 Uhr
> *Von:* Albert <alb...@gm...>
> *An:* "Torsten Hees" <A1...@gm...>
> *Cc:* "dox...@li..." <
> dox...@li...>
> *Betreff:* Re: [Doxygen-users] Preprocessor MACRO_EXPANSION +
> EXPAND_ONLY_PREDEF issue
> Dear Torsten,
>
> I tried to reproduce the problem but was not able to (I used version
> 1.8.9.1 on Windows). This might be due to an error in my Doxyfile or a
> difference in the input file (cutting and pasting does not go to well from
> the mailing list, a lot of empty lines).
>
> Can you:
> - indicate which version of doxygen you were using
> - send the input file to the mailing list as an attachment
> - indicate which items are different (with in case of EXPAND AS DEFINED
> the exact line used) from the standard Doxyfile (i.e. the Doxyfile
> generated with doxygen -g), though I think I got this right seen the
> description. (See also doxygen -s -g to get a default Doxyfile without the
> comments, so you can attach the file, in compressed format due to the
> limited size of attachments in the mailing list).
> - indicate on which output page you see the problem.
>
> Albert
>
>
> On Wed, Jan 14, 2015 at 7:44 AM, Torsten Hees <A1...@gm...> wrote:
>>
>> Hello Mailinglist,
>>
>>
>>
>> I want to expand macro function in my code. If I use a global setting,
>> its works correct, but if I want to do macro expansion only for individual
>> macros it don't expand correct.
>>
>>
>>
>> I added an example code to test it with the following settings (Doxy
>> Wizard – Preprocessor tab):
>>
>>
>>
>> Working case
>>
>> ===========================================================
>>
>> ENABLE_PREPROCESSING - set
>>
>> MACRO_EXPANSION - not set
>>
>> EXPAND_ONLY_PREDEF - not set
>>
>> SEARCH_INCLUDE - set
>>
>>
>>
>> INCLUDE_PATH
>>
>> -empty
>>
>>
>>
>> INCLUDE_FILE_PATTERNS
>>
>> -empty
>>
>>
>>
>> PREDEFINED
>>
>> -empty
>>
>>
>>
>> EXPAND_AS_DEFINED
>>
>> -empty
>>
>>
>>
>> SKIP_FUNCTION_AS_DEFINED - set
>>
>>
>>
>> Not working case
>>
>> ===========================================================
>>
>> ENABLE_PREPROCESSING - set
>>
>> MACRO_EXPANSION - not set
>>
>> EXPAND_ONLY_PREDEF - not set
>>
>> SEARCH_INCLUDE - set
>>
>>
>>
>> INCLUDE_PATH
>>
>> -empty
>>
>>
>>
>> INCLUDE_FILE_PATTERNS
>>
>> -empty
>>
>>
>>
>> PREDEFINED
>>
>> -empty
>>
>>
>>
>> EXPAND_AS_DEFINED
>>
>> - EVENTTYPE_TABLE
>>
>> - ENTRY
>>
>>
>>
>> SKIP_FUNCTION_AS_DEFINED - set
>>
>>
>>
>>
>>
>>
>>
>> Additional comment
>>
>> ===========================================================
>>
>> It's only documentated what happen if EXPAND_AS_DEFINED has entries and
>> PREDEFINED and EXPAND_AS_DEFINED is set. It's not defined what happen if
>> only one is set.
>>
>> It seems that Macro's are skiped if EXPAND_AS_DEFINED has entries and is
>> not set.
>>
>>
>>
>> I hope some one has an idea whats going work. Is it a still a bug in
>> doxygen or it is my fault.
>>
>> Best regrads
>>
>> Torsten
>>
>>
>>
>> MacroTest.h
>>
>> ===========================================================
>>
>>
>>
>> /** For an overview of the mappings of these events to the handling
>> methods in
>>
>> MacroTest, see @ref MacroTest.
>>
>> @file MacroTest.h
>>
>> */
>>
>>
>>
>> /// This is a documentation comment
>>
>> enum TypeType_t
>>
>> {
>>
>> bla1,
>>
>> bla2,
>>
>>
>>
>> PROGRAM_INTERNAL_ET = INT_MAX ///< Do not touch this. Required for
>> ensuring consistent enum type size across libraries.
>>
>> };
>>
>>
>>
>>
>>
>> /** For an overview of the mappings of these events to the handling
>> methods in
>>
>> MacroTest, see @ref MacroTest.
>>
>> @file MacroTest.h
>>
>> */
>>
>>
>>
>> /** @brief Program event types.
>>
>> */
>>
>>
>>
>> #define EVENTTYPE_TABLE \
>>
>> /** A key was pressed down. */ \
>>
>> ENTRY(ET_KEYDOWN) \
>>
>> /** A key was released. */ \
>>
>> ENTRY(ET_KEYUP) \
>>
>> /** A character key was pressed. */ \
>>
>> ENTRY(ET_CHAR) \
>>
>> /** The mouse was moved while a button was pressed. */ \
>>
>> ENTRY(DEPRECATED_ET_MOUSEDRAG) \
>>
>> /** The mouse was moved while all buttons were released. */ \
>>
>> ENTRY(ET_MOUSEMOVE) \
>>
>> /** The mousewheel was used. */ \
>>
>> ENTRY(ET_MOUSEWHEEL) \
>>
>> /** The left mouse button was released. */ \
>>
>> ENTRY(ET_LBUTTONUP) \
>>
>> /** The left mouse button was pressed. */ \
>>
>> ENTRY(ET_LBUTTONDOWN) \
>>
>> /** The left mouse button was double clicked. @ref
>> CGUIEventHandler::GetDoubleClickTime() */ \
>>
>> ENTRY(DEPRECATED_ET_LBUTTONDBLCLK) \
>>
>> /** The right mouse button was released. */ \
>>
>> ENTRY(ET_RBUTTONUP) \
>>
>> /** The right mouse button was pressed. */ \
>>
>> ENTRY(ET_RBUTTONDOWN) \
>>
>> /** The left mouse button was pressed longer than @ref
>> CGUIEventHandler::GetLongClickTime(). */ \
>>
>> ENTRY(DEPRECATED_ET_LBUTTONLONGCLICK) \
>>
>> /** A hot key was pressed (used on e.g. smart phones)*/ \
>>
>> ENTRY(ET_HOTKEYDOWN) \
>>
>> /** A hot key was released (used on e.g. smart phones)*/ \
>>
>> ENTRY(ET_HOTKEYUP)
>>
>>
>>
>> /// This is a documentation comment
>>
>> enum EventType_t
>>
>> {
>>
>> #define ENTRY(a) a,
>>
>> EVENTTYPE_TABLE
>>
>> #undef ENTRY
>>
>> PROGRAM_INTERNAL_ET = INT_MAX ///< Do not touch this. Required for
>> ensuring consistent enum type size across libraries.
>>
>> };
>>
>>
>>
>>
>>
>> /// MacroTest special doc
>>
>> /// Special comment bla bla bla
>>
>> /// bla bla bla
>>
>> /// bla bla bla
>>
>> /// bla bla bla
>>
>>
>>
>> class MacroTest
>>
>> {
>>
>> public:
>>
>> /// Constructor
>>
>> MacroTest();
>>
>> /// Destructor
>>
>> ~MacroTest();
>>
>> /// Getter
>>
>> /// bla bla bla
>>
>> /// @param i The param to get
>>
>> /// @return Pointer to MacroTest.
>>
>> MacroTest *GetMacro(int i ) {return this;};
>>
>>
>>
>> /// Setter
>>
>> /// bla bla bla
>>
>> /// @param i The param to get
>>
>> void SetMacro(int i ) {MacroTest i = 0;};
>>
>>
>>
>> /// Super duper member
>>
>> int m_i;
>>
>> /// BLABLA
>>
>> EventType_t m_EventType;
>>
>> /// Blabla
>>
>> TypeType_t m_TypeType;
>>
>> }
>>
>>
>> ------------------------------------------------------------------------------
>> New Year. New Location. New Benefits. New Data Center in Ashburn, VA.
>> GigeNET is offering a free month of service with a new server in Ashburn.
>> Choose from 2 high performing configs, both with 100TB of bandwidth.
>> Higher redundancy.Lower latency.Increased capacity.Completely compliant.
>> http://p.sf.net/sfu/gigenet
>> _______________________________________________
>> Doxygen-users mailing list
>> Dox...@li...
>> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>>
>
>
|
|
From: Albert <alb...@gm...> - 2015-01-14 09:59:40
|
Dear Torsten,
I tried to reproduce the problem but was not able to (I used version
1.8.9.1 on Windows). This might be due to an error in my Doxyfile or a
difference in the input file (cutting and pasting does not go to well from
the mailing list, a lot of empty lines).
Can you:
- indicate which version of doxygen you were using
- send the input file to the mailing list as an attachment
- indicate which items are different (with in case of EXPAND AS DEFINED the
exact line used) from the standard Doxyfile (i.e. the Doxyfile generated
with doxygen -g), though I think I got this right seen the description.
(See also doxygen -s -g to get a default Doxyfile without the comments, so
you can attach the file, in compressed format due to the limited size of
attachments in the mailing list).
- indicate on which output page you see the problem.
Albert
On Wed, Jan 14, 2015 at 7:44 AM, Torsten Hees <A1...@gm...> wrote:
> Hello Mailinglist,
>
>
>
> I want to expand macro function in my code. If I use a global setting, its
> works correct, but if I want to do macro expansion only for individual
> macros it don't expand correct.
>
>
>
> I added an example code to test it with the following settings (Doxy
> Wizard – Preprocessor tab):
>
>
>
> Working case
>
> ===========================================================
>
> ENABLE_PREPROCESSING - set
>
> MACRO_EXPANSION - not set
>
> EXPAND_ONLY_PREDEF - not set
>
> SEARCH_INCLUDE - set
>
>
>
> INCLUDE_PATH
>
> -empty
>
>
>
> INCLUDE_FILE_PATTERNS
>
> -empty
>
>
>
> PREDEFINED
>
> -empty
>
>
>
> EXPAND_AS_DEFINED
>
> -empty
>
>
>
> SKIP_FUNCTION_AS_DEFINED - set
>
>
>
> Not working case
>
> ===========================================================
>
> ENABLE_PREPROCESSING - set
>
> MACRO_EXPANSION - not set
>
> EXPAND_ONLY_PREDEF - not set
>
> SEARCH_INCLUDE - set
>
>
>
> INCLUDE_PATH
>
> -empty
>
>
>
> INCLUDE_FILE_PATTERNS
>
> -empty
>
>
>
> PREDEFINED
>
> -empty
>
>
>
> EXPAND_AS_DEFINED
>
> - EVENTTYPE_TABLE
>
> - ENTRY
>
>
>
> SKIP_FUNCTION_AS_DEFINED - set
>
>
>
>
>
>
>
> Additional comment
>
> ===========================================================
>
> It's only documentated what happen if EXPAND_AS_DEFINED has entries and
> PREDEFINED and EXPAND_AS_DEFINED is set. It's not defined what happen if
> only one is set.
>
> It seems that Macro's are skiped if EXPAND_AS_DEFINED has entries and is
> not set.
>
>
>
> I hope some one has an idea whats going work. Is it a still a bug in
> doxygen or it is my fault.
>
> Best regrads
>
> Torsten
>
>
>
> MacroTest.h
>
> ===========================================================
>
>
>
> /** For an overview of the mappings of these events to the handling
> methods in
>
> MacroTest, see @ref MacroTest.
>
> @file MacroTest.h
>
> */
>
>
>
> /// This is a documentation comment
>
> enum TypeType_t
>
> {
>
> bla1,
>
> bla2,
>
>
>
> PROGRAM_INTERNAL_ET = INT_MAX ///< Do not touch this. Required for
> ensuring consistent enum type size across libraries.
>
> };
>
>
>
>
>
> /** For an overview of the mappings of these events to the handling
> methods in
>
> MacroTest, see @ref MacroTest.
>
> @file MacroTest.h
>
> */
>
>
>
> /** @brief Program event types.
>
> */
>
>
>
> #define EVENTTYPE_TABLE \
>
> /** A key was pressed down. */ \
>
> ENTRY(ET_KEYDOWN) \
>
> /** A key was released. */ \
>
> ENTRY(ET_KEYUP) \
>
> /** A character key was pressed. */ \
>
> ENTRY(ET_CHAR) \
>
> /** The mouse was moved while a button was pressed. */ \
>
> ENTRY(DEPRECATED_ET_MOUSEDRAG) \
>
> /** The mouse was moved while all buttons were released. */ \
>
> ENTRY(ET_MOUSEMOVE) \
>
> /** The mousewheel was used. */ \
>
> ENTRY(ET_MOUSEWHEEL) \
>
> /** The left mouse button was released. */ \
>
> ENTRY(ET_LBUTTONUP) \
>
> /** The left mouse button was pressed. */ \
>
> ENTRY(ET_LBUTTONDOWN) \
>
> /** The left mouse button was double clicked. @ref
> CGUIEventHandler::GetDoubleClickTime() */ \
>
> ENTRY(DEPRECATED_ET_LBUTTONDBLCLK) \
>
> /** The right mouse button was released. */ \
>
> ENTRY(ET_RBUTTONUP) \
>
> /** The right mouse button was pressed. */ \
>
> ENTRY(ET_RBUTTONDOWN) \
>
> /** The left mouse button was pressed longer than @ref
> CGUIEventHandler::GetLongClickTime(). */ \
>
> ENTRY(DEPRECATED_ET_LBUTTONLONGCLICK) \
>
> /** A hot key was pressed (used on e.g. smart phones)*/ \
>
> ENTRY(ET_HOTKEYDOWN) \
>
> /** A hot key was released (used on e.g. smart phones)*/ \
>
> ENTRY(ET_HOTKEYUP)
>
>
>
> /// This is a documentation comment
>
> enum EventType_t
>
> {
>
> #define ENTRY(a) a,
>
> EVENTTYPE_TABLE
>
> #undef ENTRY
>
> PROGRAM_INTERNAL_ET = INT_MAX ///< Do not touch this. Required for
> ensuring consistent enum type size across libraries.
>
> };
>
>
>
>
>
> /// MacroTest special doc
>
> /// Special comment bla bla bla
>
> /// bla bla bla
>
> /// bla bla bla
>
> /// bla bla bla
>
>
>
> class MacroTest
>
> {
>
> public:
>
> /// Constructor
>
> MacroTest();
>
> /// Destructor
>
> ~MacroTest();
>
> /// Getter
>
> /// bla bla bla
>
> /// @param i The param to get
>
> /// @return Pointer to MacroTest.
>
> MacroTest *GetMacro(int i ) {return this;};
>
>
>
> /// Setter
>
> /// bla bla bla
>
> /// @param i The param to get
>
> void SetMacro(int i ) {MacroTest i = 0;};
>
>
>
> /// Super duper member
>
> int m_i;
>
> /// BLABLA
>
> EventType_t m_EventType;
>
> /// Blabla
>
> TypeType_t m_TypeType;
>
> }
>
>
> ------------------------------------------------------------------------------
> New Year. New Location. New Benefits. New Data Center in Ashburn, VA.
> GigeNET is offering a free month of service with a new server in Ashburn.
> Choose from 2 high performing configs, both with 100TB of bandwidth.
> Higher redundancy.Lower latency.Increased capacity.Completely compliant.
> http://p.sf.net/sfu/gigenet
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>
|
|
From: Torsten H. <A1...@gm...> - 2015-01-14 06:44:12
|
<html><head></head><body><div style="font-family: Verdana;font-size: 12.0px;"><div>
<div style="font-family: Verdana;font-size: 12.0px;">
<div>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">Hello Mailinglist,</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;"> </p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">I want to expand macro function in my code. If I use a global setting, its works correct, but if I want to do macro expansion only for individual macros it don't expand correct.</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;"> </p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">I added an example code to test it with the following settings (Doxy Wizard – Preprocessor tab):</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;"> </p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">Working case</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">===========================================================</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">ENABLE_PREPROCESSING - set</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">MACRO_EXPANSION - not set</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">EXPAND_ONLY_PREDEF - not set</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">SEARCH_INCLUDE - set</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;"> </p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">INCLUDE_PATH</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">-empty</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;"> </p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">INCLUDE_FILE_PATTERNS</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">-empty</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;"> </p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">PREDEFINED</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">-empty</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;"> </p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">EXPAND_AS_DEFINED</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">-empty</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;"> </p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">SKIP_FUNCTION_AS_DEFINED - set</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;"> </p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">Not working case</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">===========================================================</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">ENABLE_PREPROCESSING - set</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">MACRO_EXPANSION - not set</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">EXPAND_ONLY_PREDEF - not set</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">SEARCH_INCLUDE - set</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;"> </p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">INCLUDE_PATH</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">-empty</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;"> </p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">INCLUDE_FILE_PATTERNS</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">-empty</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;"> </p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">PREDEFINED</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">-empty</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;"> </p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">EXPAND_AS_DEFINED</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">- EVENTTYPE_TABLE</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">- ENTRY</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;"> </p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">SKIP_FUNCTION_AS_DEFINED - set</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;"> </p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;"> </p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;"> </p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">Additional comment</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">===========================================================</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">It's only documentated what happen if EXPAND_AS_DEFINED has entries and PREDEFINED and EXPAND_AS_DEFINED is set. It's not defined what happen if only one is set.</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">It seems that Macro's are skiped if EXPAND_AS_DEFINED has entries and is not set.</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;"> </p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">I hope some one has an idea whats going work. Is it a still a bug in doxygen or it is my fault.</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">Best regrads</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">Torsten</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;"> </p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">MacroTest.h</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">===========================================================</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;"> </p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">/** For an overview of the mappings of these events to the handling methods in</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">MacroTest, see @ref MacroTest.</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">@file MacroTest.h</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">*/</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;"> </p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">/// This is a documentation comment</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">enum TypeType_t</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">{</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">bla1,</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">bla2,</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;"> </p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">PROGRAM_INTERNAL_ET = INT_MAX ///< Do not touch this. Required for ensuring consistent enum type size across libraries.</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">};</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;"> </p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;"> </p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">/** For an overview of the mappings of these events to the handling methods in</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">MacroTest, see @ref MacroTest.</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">@file MacroTest.h</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">*/</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;"> </p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">/** @brief Program event types.</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">*/</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;"> </p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">#define EVENTTYPE_TABLE \</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">/** A key was pressed down. */ \</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">ENTRY(ET_KEYDOWN) \</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">/** A key was released. */ \</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">ENTRY(ET_KEYUP) \</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">/** A character key was pressed. */ \</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">ENTRY(ET_CHAR) \</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">/** The mouse was moved while a button was pressed. */ \</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">ENTRY(DEPRECATED_ET_MOUSEDRAG) \</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">/** The mouse was moved while all buttons were released. */ \</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">ENTRY(ET_MOUSEMOVE) \</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">/** The mousewheel was used. */ \</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">ENTRY(ET_MOUSEWHEEL) \</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">/** The left mouse button was released. */ \</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">ENTRY(ET_LBUTTONUP) \</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">/** The left mouse button was pressed. */ \</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">ENTRY(ET_LBUTTONDOWN) \</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">/** The left mouse button was double clicked. @ref CGUIEventHandler::GetDoubleClickTime() */ \</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">ENTRY(DEPRECATED_ET_LBUTTONDBLCLK) \</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">/** The right mouse button was released. */ \</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">ENTRY(ET_RBUTTONUP) \</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">/** The right mouse button was pressed. */ \</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">ENTRY(ET_RBUTTONDOWN) \</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">/** The left mouse button was pressed longer than @ref CGUIEventHandler::GetLongClickTime(). */ \</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">ENTRY(DEPRECATED_ET_LBUTTONLONGCLICK) \</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">/** A hot key was pressed (used on e.g. smart phones)*/ \</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">ENTRY(ET_HOTKEYDOWN) \</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">/** A hot key was released (used on e.g. smart phones)*/ \</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">ENTRY(ET_HOTKEYUP)</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;"> </p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">/// This is a documentation comment</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">enum EventType_t</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">{</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">#define ENTRY(a) a,</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">EVENTTYPE_TABLE</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">#undef ENTRY</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">PROGRAM_INTERNAL_ET = INT_MAX ///< Do not touch this. Required for ensuring consistent enum type size across libraries.</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">};</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;"> </p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;"> </p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">/// MacroTest special doc</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">/// Special comment bla bla bla</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">/// bla bla bla</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">/// bla bla bla</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">/// bla bla bla</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;"> </p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">class MacroTest</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">{</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">public:</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">/// Constructor</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">MacroTest();</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">/// Destructor</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">~MacroTest();</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">/// Getter</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">/// bla bla bla</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">/// @param i The param to get</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">/// @return Pointer to MacroTest.</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">MacroTest *GetMacro(int i ) {return this;};</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;"> </p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">/// Setter</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">/// bla bla bla</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">/// @param i The param to get</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">void SetMacro(int i ) {MacroTest i = 0;};</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;"> </p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">/// Super duper member</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">int m_i;</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">/// BLABLA</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">EventType_t m_EventType;</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">/// Blabla</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">TypeType_t m_TypeType;</p>
<p style="margin-bottom: 0.0cm;line-height: 100.0%;">}</p>
</div>
</div>
</div></div></body></html>
|
|
From: Jens F. <fra...@st...> - 2015-01-12 07:48:12
|
Hi Dimitri,
enabling BUILTIN_STL_SUPPORT does show up all the STL Objects created in the class but not the one handle over to the constructor. (with defining: namespace std { template<class T> class shared_ptr { T *dummy; }; } )
class MyClass {
public:
MyClass(std::shared_ptr<embedded_type> input, second_embedded_type input2);
// second_embedded_type is show as embedded class visualized by the diamond symbol, embedded_type not
// -> both (and also unique_ptrs and week_ptr should be show as like they are raw pointers
private: //also for public if not enabling ~Show_private....
std::string myString;
std::unique_ptr myPTR;
// both are show as embedded visualized by the diamond symbol, string is displayed as typedef (orange arrow) from basic_string<char>, myPTR from unique_ptr<T> which embeds T
// -> all of this should not been shown
};
Regards, Jens |
|
From: Philipp K. <phi...@fl...> - 2015-01-11 16:13:29
|
Hello,
I’m using inline code in my HTML documentation with Doxygen 1.8.9.
The Java code shows e.g.:
public void someMethod()
{
System.out.println(„test“);
}
The inline code starts with { and inserts the spaces bevor the System.out call. How can I remove the { without reformatting my code
and the spaces before the System.out call, I would like to show the inline code like this
<line nr> System.out.println(„test“);
and not
<line nr> {
<line nr> System.out.println(„test“);
Thanks
Phil
|
|
From: Uwe S. <u.s...@gm...> - 2015-01-10 21:41:26
|
Dimitri van Heesch <do...@gm...> schrieb am [Sa, 10.01.2015 19:17]:
> > On 10 Jan 2015, at 13:56 , Uwe Scholz <u.s...@gm...> wrote:
> > It is not possible to find "s$foo_bar" in the HTML-search field from the
> > doxygen HTML pages. Modifying "find html/ -type f" to "find html/
> > -maxdepth 1 -type f" in step 5 makes it possible that all these
> > s$-functions can be found by typing "__sdollar__...".
> >
> > So, there seems to be a problem with the doxygen search-engine and
> > function names with dollar signs.
>
> This is a bit more tricky indeed.
>
> In the html/search directory there are a number of .js files.
> You need to replace '_5f_5fsdollar_5f_5f' with 's_24' there,
> and also make sure the searchdata.js file has the letter 's' in indexSectionsWithContent for
> the rows matching 'all' and 'functions', i.e.
>
I did this with the following scripts:
for II in $(find html/ -type f); do sed 's/__sdollar__/s\$/g' -i $II; done
for II in $(find html/search/*.js -type f); do sed 's/_5f_5fsdollar_5f_5f/s_24/g' -i $II; done
After this, indexSectionsWithContent in search.js looks still like this:
var indexSectionsWithContent =
{
0: "_f",
1: "f",
2: "_"
};
and replacing "_" with "s" makes that one can find "s$foo_bar" in the
html search field. Great!
Unfortunately, this is not working when there is another function
definition in foo.c, starting with "s" already:
void s$foo_bar(){}
void search(){}
After executing doxygen and the two sed scripts from above,
indexSectionsWithContent in search.js still looks like this:
var indexSectionsWithContent =
{
0: "_fs",
1: "f",
2: "_s"
};
and typing "s" in the html search field yields only the function
"search" in foo.c. Typing "_" yields nothing. Removing "_" in search.js
even shows no single search result when typing one of "s", "_" or "f".
I don't really get what is the cause for this behaviour and how to find
"s$foo_bar", when there already is another function beginning with "s"
in my C file. :-)
But up to now: Thank you very much! I think I can also live with
searching for "__sdollar__ in the html search field.
Regards
Uwe
|
|
From: Martin G. <mon...@op...> - 2015-01-10 18:28:03
|
Hi there,
I want to share some problem solution we found.
Some time ago there was a question regarding doxygen and table of
content (TOC) generation of text with markdown syntax.
See old email at the end. (sorry found no other easy way to reference
the mail)
Answer on question:
It works but you need to add an header id attribute, e.g.
/**
[TOC]
# Foo {#foo}
## Glop {#glob}
# Bar {#bar}
**/
This way a correct TOC is build by doxygen.
Thanks,
folks
============old mail================================
Hi all,
I'd like to use the automatic table of contents in the new Markdown
syntax but it does not work: if I do something like that;
/**
[TOC]
# Foo
## Glop
# Bar
**/
The table of contents is not displayed in the HTML output.
Am I doing right ?
thanks, regards,
david
|
|
From: Dimitri v. H. <do...@gm...> - 2015-01-10 18:17:14
|
> On 10 Jan 2015, at 13:56 , Uwe Scholz <u.s...@gm...> wrote:
>
> Hi Dimitri,
>
> Dimitri van Heesch <do...@gm...> schrieb am [Sa, 10.01.2015 11:38]:
>> Hi Uwe,
>>
>> What you could do is write an input filter (see the INPUT_FILTER option)
>> that lets doxygen replace the 's$' by something that can be part of an identifier, e.g. '__sdollar__'
>> Then you need to post-process the output and replace the '__sdollar__'s back to 's$'.
>
> Great! Thank you for this tip, it helped me already!
>
> But there is still one (small) problem regarding the HTML search field now:
>
> Here is what I did so far:
> 1: doxygen -g
> 2: Set EXTRACT_ALL to YES
> 3: echo "void s$foo_bar();" > foo.c
> 4: doxygen
> 5: for II in $(find html/ -type f); do sed 's/__sdollar__/s\$/g' -i $II; done
>
> It is not possible to find "s$foo_bar" in the HTML-search field from the
> doxygen HTML pages. Modifying "find html/ -type f" to "find html/
> -maxdepth 1 -type f" in step 5 makes it possible that all these
> s$-functions can be found by typing "__sdollar__...".
>
> So, there seems to be a problem with the doxygen search-engine and
> function names with dollar signs.
This is a bit more tricky indeed.
In the html/search directory there are a number of .js files.
You need to replace '_5f_5fsdollar_5f_5f' with 's_24' there,
and also make sure the searchdata.js file has the letter 's' in indexSectionsWithContent for
the rows matching 'all' and 'functions', i.e.
var indexSectionsWithContent =
{
0: "st",
1: "t",
2: "s"
};
in your example.
Regards,
Dimitri
|
|
From: Uwe S. <u.s...@gm...> - 2015-01-10 17:54:21
|
Uwe Scholz <u.s...@gm...> schrieb am [Sa, 10.01.2015 13:56]: > Here is what I did so far: > 1: doxygen -g > 2: Set EXTRACT_ALL to YES I forgot to write the following after point 2: INPUT_FILTER = "sed 's/s\$/__sdollar__/g'" FILTER_SOURCE_FILES = YES > 3: echo "void s$foo_bar();" > foo.c > 4: doxygen > 5: for II in $(find html/ -type f); do sed 's/__sdollar__/s\$/g' -i $II; done Regards Uwe |
|
From: Dimitri v. H. <do...@gm...> - 2015-01-10 09:46:41
|
Hi Jens,
Did you already try to enable BUILTIN_STL_SUPPORT?
That basically does what the workaround below does, but then marks the classes as internal/artificial,
so they don't appear in the output.
Regards,
Dimitri
> On 07 Jan 2015, at 8:20 , Jens Frangenheim <fra...@st...> wrote:
>
> Since the discussion and workarounds in
>
> Getting shared_ptr refs to appear in collaboration diagrams..... Eric J. Holtman 2010-03-01
>
> and
>
> Re: templates and association diagrams James Ahlborn 2004-08-04
>
> there is now the C++11 (and 14) standard (and one dos not need boost for certain smart pointer anymore)
>
> and I am still searching for an solution which is showing an embedded class object by a smart pointer
> (std::shared_ptr, std::week_ptr, std::unique_ptr) like a usual raw pointer.
>
> When generating UML look diagrams raw pointer s are indicated which the usually diamond symbol,
>
> but classed embedded by smart pointers are not shown.
>
> The workarounds managed in the posts (namespace std { template<class T> class shared_ptr { T *dummy; }; } )
>
> above are not solving the problem because they are showing an intermediate object "shared_ptr"
> between class and embedded class object.
>
>
> (Maybe there are some good reasons that doxygen will not show all classes embedded in containers but
>
> since smart pointer can be use and treated like raw pointers (and provide a lot of advantages) I know no reasons why they should not be displayed like raw pointers.)
>
> Best Regards, Jens Frangenheim
> ------------------------------------------------------------------------------
> Dive into the World of Parallel Programming! The Go Parallel Website,
> sponsored by Intel and developed in partnership with Slashdot Media, is your
> hub for all things parallel software development, from weekly thought
> leadership blogs to news, videos, case studies, tutorials and more. Take a
> look and join the conversation now. http://goparallel.sourceforge.net_______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
|
|
From: Uwe S. <u.s...@gm...> - 2015-01-09 15:06:59
|
Hi,
I'm trying to document C code with doxygen for an OpenVOS System.
There, they are using a special C dialect ("VOS C").
For the system there I am working on there exist so-called system
subroutines. These subroutines are basically simple C-functions.
But to distinguish them from "normal" functions, they all have
the common name style "s$foo_bar". Note the Dollar sign!
See this link [*] for a list of common Stratus subroutines.
Unfortunately, doxygen can not handle them correctly. Here is an
example to test this for your own:
1: Generate a Doxyfile with "doxygen -g"
2: Set EXTRACT_ALL to YES
3: Do echo "void s$foo_bar();" > foo.c
4: Run doxygen.
Now, the HTML output of doxygen tells me that this function
declaration is in the source code:
"void s $foo_bar ()"
One can even better realize what's going on when activating
"SOURCE_BROWSER = YES" in Doxyfile. Then, you can click only on
"$foo_bar" when you open the xource code page in your web browser.
What I would expect here is "s$foo_bar" as the (clickable) function
name.
Can this be solved somehow? I wouldn't say that this is a bug
because VOS C is a rare C dialect. But I would like to know if
Dollar ($) signs in C function names can be correctly parsed by
Doxygen somehow.
Thanks for any help
Uwe
[*]
http://stratadoc.stratus.com/vos/17.1.1/r068-12/wwhelp/wwhimpl/common/html/wwhelp.htm?context=r068-12&file=prefacer068-12.html
|
|
From: Jens F. <fra...@st...> - 2015-01-07 07:33:32
|
Since the discussion and workarounds in Getting shared_ptr refs to appear in collaboration diagrams..... Eric J. Holtman 2010-03-01 and Re: templates and association diagrams James Ahlborn 2004-08-04 there is now the C++11 (and 14) standard (and one dos not need boost for certain smart pointer anymore)
and I am still searching for an solution which is showing an embedded class object by a smart pointer
(std::shared_ptr, std::week_ptr, std::unique_ptr) like a usual raw pointer. When generating UML look diagrams raw pointer s are indicated which the usually diamond symbol,
but classed embedded by smart pointers are not shown. The workarounds managed in the posts (namespace std { template<class T> class shared_ptr { T *dummy; }; } )
above are not solving the problem because they are showing an intermediate object "shared_ptr"
between class and embedded class object. (Maybe there are some good reasons that doxygen will not show all classes embedded in containers but
since smart pointer can be use and treated like raw pointers (and provide a lot of advantages) I know no reasons why they should not be displayed like raw pointers.)
Best Regards, Jens Frangenheim
|
|
From: Albert <alb...@gm...> - 2015-01-06 18:24:39
|
Which output format are you talking about? HTML see the HTML_EXTRA_STYLESHEET and the default stylesheet doxygen.css Albert (Initially forgot the group) On Mon, Jan 5, 2015 at 10:30 PM, Krzysztof <kj...@li...> wrote: > Where can I control typeface of e.g. code fragments (such as beginning > with @c or <tt>)? > > -- > Regards > Krzysztof J. > > > > > ------------------------------------------------------------------------------ > Dive into the World of Parallel Programming! The Go Parallel Website, > sponsored by Intel and developed in partnership with Slashdot Media, is > your > hub for all things parallel software development, from weekly thought > leadership blogs to news, videos, case studies, tutorials and more. Take a > look and join the conversation now. http://goparallel.sourceforge.net > _______________________________________________ > Doxygen-users mailing list > Dox...@li... > https://lists.sourceforge.net/lists/listinfo/doxygen-users > |
|
From: Krzysztof <kj...@li...> - 2015-01-06 18:10:30
|
Where can I control typeface of e.g. code fragments (such as beginning with @c or <tt>)? -- Regards Krzysztof J. |
|
From: Eckard K. <eck...@t-...> - 2015-01-03 15:16:19
|
Hello Everybody. I wish you a happy new year. Since some years I'm providing Moritz a tool to generate source diagrams. First Moritz started with html-based nassi shneiderman diagrams and since last year dot-based UML like activity diagrams are available also. Currently I'm working on a possibility to create mscgen-based message sequence charts. Even this feature is not available until now for you, I have posted today a new snapshot for windows and linux. For other operation-systems the source-code is provided and the both binaries abc2xml and xml2abc should be usable with the linux distribution then. Please take a look at: https://sourceforge.net/projects/moritz/files/Moritz_2.x/DevelopmentFor_2_1_0/Snapshot_2_0_2/ <https://sourceforge.net/projects/moritz/files/Moritz_2.x/DevelopmentFor_2_1_0/Snapshot_2_0_2> Here you will find a windows-distribution and one for linux (build with Ubuntu 14.04 for a 32bit system). Furthermore a the sources for the two binaries abc2xml and xml2abc. New is a sub folder in this snapshot with some tutorials: 1. An introduction that explains a basic source example and the set up of the used tools. 2. A nassi shneiderman diagram example that shows how to create them and hoe to use them with doxygen. 3. A UML like activity diagram example that shows how to create them and hoe to use them with doxygen. It would be kind if you would find the time to test it and please post a comment in the forum from Moritz. Best regards, Eckard Klotz. |
|
From: Ed Smith-R. <3d...@ve...> - 2014-12-31 17:01:20
|
In C++ there is a new namespace syntax that allows callers to elide the
namespace
namespace A {
inline namespace B {
namespace C {
int foo(int);
}
}
}
auto i = A::C::foo(21);
These are often used to support internal versioning.
Often it is hoped users wouldn't need or want to specify inline
namespace scope.
In doxygen I would like to possibly
* elide inline namespaces in docs - probably with a config variable.
* and/or create output that you could toggle whether/how inline
namespaces appear in docs.
* and/or Have inline namespaces appear grayed out or something when
listing a library component.
Many possibilities are potentially useful to people at different times.
Is there something like this now?
If not could we add it?
Ed
|
|
From: Walter F.J. M. <w.f...@re...> - 2014-12-31 15:57:30
|
Hi,
beyond the grave speed issues I found three other things worth commenting
in the new VHDL parser used in doxygen 1.8.9:
- it does not accept a 'begin' after an 'if generate' without declarations
in between. In that case 'begin' is optional. Code like
PC11: if true generate
begin
I0 : ibdr_pc11
port map (
....
);
end generate PC11;
creates a message like
syntax error at line: nnn : begin
- the construct
if L(L'left+1) = '"' then
creates a
syntax error at line: 493 : '
Unfortunately it doesn't tell which ' is not understood. The context is
procedure readgen( -- read slv generic base
L: inout line; -- line
...
if L'length >= 2 then
if L(L'left+1) = '"' then
case L(L'left) is
- these 'syntax error' lines are written to stderr. When stdout and stderr
both go to terminal they appear behind "Reading <filename>..." line.
When using
doxygen-1.8.9 -d time test.Doxyfile 2>&1 | tee doxygen-1.8.9.log
they a come completely out of sync and can't be associated with the
source file.
Both syntax errors don't appear under doxygen 1.8.7.
With best regards, Walter
|
|
From: Walter F.J. M. <w.f...@re...> - 2014-12-31 15:25:11
|
On 12/30/2014 07:10 PM, Dimitri van Heesch wrote:
> That doesn't sound right.
> Would be nice to understand what doxygen is doing but I haven't been able to reproduce this.
>
> What options are enabled?
> Can you do some profiling? Can you run with the '-d time' option for instance?
> Does this also happen if you use a smaller subset of the code?
Hi Dimitri,
the CPU time seems to grow dramatically with increasing project size.
The case I described has all designs I have included. To trace the
issue I've setup a test environment with the sources of a single
design, now 117 files and 28428 lines of code. Now run times for
"doxygen -d time" are
doxygen-1.8.7 real 0m07.963s user 0m08.510s sys 0m02.143s
Spent 0.849 seconds in Generating file sources...
Spent 1.106 seconds in Generating class documentation...
Spent 3.919 seconds in Running dot...
doxygen-1.8.9 real 8m32.386s user 8m32.438s sys 0m02.231s
Spent 329.133 seconds in Generating file sources...
Spent 177.439 seconds in Generating class documentation...
Spent 4.096 seconds in Running dot...
I've also done some profiling with "valgrind --tool=callgrind".
A quick looks seems to indicate that a lot of time is burned in
QGList::contains(), suggesting that a list is searched. The
pertinent part of the callgrind_annotate output for 1.8.9 is
150,241,637,969 < VhdlDocGen::findMember(...)
150,241,637,969 * VhdlDocGen::findMemberDef(...)
794,272 > QMapPrivate<QCString, MemberDef*>::insert(...)
21,869 > QGList::append(...)
1,541,745,005 > QCString::StringRep::StringRep(...)
1,824,725,951 > Definition::symbolName(...)
51,057 > ClassDef::getMemberList(...)
19,746 > QGListIterator::operator++(...)
22,775 > MemberListIterator::MemberListIterator(...)
102,891,546,408 > QGList::contains(...)
14,700,790,148 > ...:__strcmp_sse2_unaligned (...)
4,437,837,537 > QCString::operator+=(...)
812 > QCString::StringRep::data(...)
21,024 > QGListIterator::~QGListIterator(...)
1,686,722,110 > QCString::StringRep::~StringRep(...)
500,621 > QCString::StringRep::StringRep(...)
2,160 > QMap<QCString, MemberDef*>::detach(...)
8,384,846,588 > operator+(...)
1,215 > QGListIterator::toFirst(...)
Note that I aborted valgrind after about an hour, running doxygen under
valgrind is a factor 20 slower that running it directly.
The same section of a callgrind_annotate output for 1.8.7, done after
a full document creation run, looks like
14,153,463 < VhdlDocGen::writeVHDLTypeDocumentation(...)
1,722,043,706 < generateMemLink(...)
654,130,388 < VhdlDocGen::writeStringLink(...)
2,390,327,557 * VhdlDocGen::findMember(...)
510,960 > QGDictIterator::toFirst(...)
8,278,421 > QCString::QCString(...)
133,736,676 > VhdlDocGen::getClass(...)
1,955,829,369 > VhdlDocGen::findAllPackages(...)
2,402,164 > QCString::upper(...)
3,670,712 > ClassDef::className(...)
298,851 > ClassDef::protection(...)
15,384,427 > QGDict::QGDict(...)
11,590,565 > QGDictIterator::QGDictIterator(...)
13,977,784 > QGDict::~QGDict(...)
736,485 > QGDict::clear(...)
3,625,505 > QCString::assign(...)
154,335 > Definition::getOuterScope(...)
218,592,559 > VhdlDocGen::findMemberDef(...)
5,995,264 > QGDictIterator::~QGDictIterator(...)
8,458,217 > QCString::~QCString(...)
2,396,524 > QCString::lower(...)
I hope that helps a bit.
With best regards, Walter
|
|
From: Dimitri v. H. <do...@gm...> - 2014-12-30 18:10:59
|
Hi Walter, > On 30 Dec 2014, at 16:24 , Walter F.J. Mueller <w.f...@re...> wrote: > > Hi, > > I'm using doxygen to generate a 'source code browser pages' for a > medium sized VHDL project. Some is publicly visible under > http://www.retro11.de/doxy/w11/vhd/html/hierarchy.html > Total volume is > ~ 450 files > ~ 85000 lines > > With doxygen 1.8.7 it took about 32 sec to generate the files ! > > With doxygen 1.8.9 this slowed down to a snake-speed crawl. Even after > more than 18 CPU hours (!!) the files aren't done. The job isn't hung, > it's very slowly progressing, one sees a new 'Generating docs' line > very few minutes. Resource consumption seems reasonable top gives > > PR NI VIRT RES SHR S %CPU %MEM TIME+ COMMAND > 30 10 125660 73620 4688 R 99.8 1.8 1100:32 doxygen > > I also tried doxygen 1.8.8, same observation, it proceeds, but at > a dreadfully slow pace. > > In 1.8.8 the VHDL parser was changed, in 1.8.9 many VHDL fixes > were done. So my question: > > Does anybody else see such dramatic performance issues with > doxygen 1.8.8/1.8.9 and VHDL ? That doesn't sound right. Would be nice to understand what doxygen is doing but I haven't been able to reproduce this. What options are enabled? Can you do some profiling? Can you run with the '-d time' option for instance? Does this also happen if you use a smaller subset of the code? Regards, Dimitri |
194 messages has been excluded from this view by a project administrator.
