doxygen-users Mailing List for Doxygen (Page 9)
Brought to you by:
dimitri
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: Robert H. <he...@de...> - 2019-11-04 16:13:56
|
At Mon, 4 Nov 2019 15:16:15 +0000 "Kerry, Richard" <ric...@at...> wrote: > > Content-Language: en-US > > > > > I have a very large marked up comment which I would like to process using Doxygen to generate just one straightforward html file, and I don't seem to be getting any useful output. > I don't need a full Doxygen mini web-site, just one page representing a straightforward html conversion of the comment with its markup. It will be incorporated into an existing html structure, so doesn't need Doxygen's auto-generated navigation or search systems. > I am happy to do some editing on the comment as I am sure that will be necessary, but I don't want to hand-translate it all to html. Everything I want is present, together with a load that I don't, and I will remove that in due course. > > I think one significant issue is that because there is no source code at all, only a comment, the result has no meaningful content in the output. I can't see any parameters that obviously relate to this issue. > > I've set DISABLE_INDEX to YES, and SEARCHINDEX to NO but there are still some .js files being generated. And although I'm pointing HTML_HEADER/FOOTER at my own header and footer files I'm still getting a load of png files written corresponding to bits of visual framework that Doxygen's own instances use. > Set SEARCHENGINE and SERVER_BASED_SEARCH to NO as well. > I suspect there are a handful of key features I need to deal with in order to get this to work, and I would appreciate any pointers of where to start looking. > > > A bit of background detail... > > What I've got is actually a header comment for part of Qt [1], specifically the Regular Expression module. > My application will make Qt regular expression format accessible to the user, and I want some documentation for the syntax. At the top of Qt's implementation file is a very long comment (over 600 lines), a lot of which is a detailed explanation of the syntax, so I want to use most of that. It already has loads of mark-up, which is interpreted by Qt's documentation generator and turned into html. Given that Qt's auto-documentation syntax is a precursor to Doxygen I am assuming that they are similar enough that Doxygen can process what I've got. > > I am assuming that Doxygen can do this in isolation, without any source code included, as it is obviously capable of doing this kind of transformation as part of the complex html that it generates by default, and it looks like the Doxygen web-site's documentation pages are generated by Doxygen but show no source code. I am looking for more pointers on how to turn off areas that are still being generated by doxygen, and the key to why it isn't generating anything from the main comment. You are not going to get Doxygen to create one .html file and nothing else. Doxygen will drop its additional "overhead" files into the output html directory, even if your .html file does not reference them. It will include an index.html (even if it is basically empty), and some other .html files autogenerated. That said, it should be possible to create a .html file you can copy out of Doxygen's output directory to your own web pages. Read the commentary in your [generated] Doxyfile under HTML_HEADER and HTML_FOOTER and HTML_STYLESHEET *carefully* -- use "doxygen -w html new_header.html new_footer.html new_stylesheet.css" and then edit each of new_header.html, new_footer.html, and new_stylesheet.css to suit your web pages and specify these three files in your Doxyfile. If your HTML_HEADER, HTML_FOOTER, and HTML_STYLESHEET files are crafted properly, you should end up with a single .html file you can copy away from Doxygen's output. Doxygen will still drop some other random files in that directory that you will just ignore. > > Regards, > Richard. > > [1] actually Qt3. Yes, I know, "it's historical". > > > Richard Kerry > BNCS Engineer, Global Media Practice > > M: +44 (0)7812 325518 > 2nd Floor, MidCity Place, 71 High Holborn, London, WC1V 6EA > ric...@at...<mailto:ric...@at...> > > [cid:image002.png@01D5930E.DB6E45C0] > > [Email-signature-banner_IBC-2019] > > Content-Description: image001.png > > > This message contains data in an unrecognized format, image/png, > which is being decoded and written to the file named "/home/heller/Mail/Attachments/352-image001.png". > If you do not want this data, you probably should delete that file. > Wrote file /home/heller/Mail/Attachments/352-image001.png > Content-Description: image002.png > > > This message contains data in an unrecognized format, image/png, > which is being decoded and written to the file named "/home/heller/Mail/Attachments/327-image002.png". > If you do not want this data, you probably should delete that file. > Wrote file /home/heller/Mail/Attachments/327-image002.png > Content-Description: image004.jpg > > > This message contains data in an unrecognized format, image/jpeg, > which is being decoded and written to the file named "/home/heller/Mail/Attachments/25-image004.jpg". > If you do not want this data, you probably should delete that file. > Wrote file /home/heller/Mail/Attachments/25-image004.jpg > MIME-Version: 1.0 > > > MIME-Version: 1.0 > > _______________________________________________ > Doxygen-users mailing list > Dox...@li... > https://lists.sourceforge.net/lists/listinfo/doxygen-users > > -- Robert Heller -- 978-544-6933 Deepwoods Software -- Custom Software Services http://www.deepsoft.com/ -- Linux Administration Services he...@de... -- Webhosting Services |
From: Kerry, R. <ric...@at...> - 2019-11-04 15:39:14
|
I think I can answer my own question here - use the ALIASES parameter. ALIASES += section1=\section Richard Kerry BNCS Engineer, Global Media Practice M: +44 (0)7812 325518 2nd Floor, MidCity Place, 71 High Holborn, London, WC1V 6EA ric...@at...<mailto:ric...@at...> [cid:ima...@01...614F20] [Email-signature-banner_IBC-2019] From: Kerry, Richard <ric...@at...> Sent: Monday, November 04, 2019 3:34 PM To: dox...@li... Subject: [Doxygen-users] \section1 is presumably no longer valid, can I reinstate it? In trying to process some old Qt markup using Doxygen I think I am being told that \section1 is not valid markup. If this is so I presume this is something that has been obsoleted since the file was originally written. I know I can change them all to \section, but is there a way of aliasing \section1 to \section? Regards, Richard. Richard Kerry BNCS Engineer, Global Media Practice M: +44 (0)7812 325518 2nd Floor, MidCity Place, 71 High Holborn, London, WC1V 6EA ric...@at...<mailto:ric...@at...> [cid:image002.png@01D59324.521BFF90] [Email-signature-banner_IBC-2019] |
From: Kerry, R. <ric...@at...> - 2019-11-04 15:34:26
|
In trying to process some old Qt markup using Doxygen I think I am being told that \section1 is not valid markup. If this is so I presume this is something that has been obsoleted since the file was originally written. I know I can change them all to \section, but is there a way of aliasing \section1 to \section? Regards, Richard. Richard Kerry BNCS Engineer, Global Media Practice M: +44 (0)7812 325518 2nd Floor, MidCity Place, 71 High Holborn, London, WC1V 6EA ric...@at...<mailto:ric...@at...> [cid:image002.png@01D59324.521BFF90] [Email-signature-banner_IBC-2019] |
From: Kerry, R. <ric...@at...> - 2019-11-04 15:24:05
|
I have a very large marked up comment which I would like to process using Doxygen to generate just one straightforward html file, and I don't seem to be getting any useful output. I don't need a full Doxygen mini web-site, just one page representing a straightforward html conversion of the comment with its markup. It will be incorporated into an existing html structure, so doesn't need Doxygen's auto-generated navigation or search systems. I am happy to do some editing on the comment as I am sure that will be necessary, but I don't want to hand-translate it all to html. Everything I want is present, together with a load that I don't, and I will remove that in due course. I think one significant issue is that because there is no source code at all, only a comment, the result has no meaningful content in the output. I can't see any parameters that obviously relate to this issue. I've set DISABLE_INDEX to YES, and SEARCHINDEX to NO but there are still some .js files being generated. And although I'm pointing HTML_HEADER/FOOTER at my own header and footer files I'm still getting a load of png files written corresponding to bits of visual framework that Doxygen's own instances use. I suspect there are a handful of key features I need to deal with in order to get this to work, and I would appreciate any pointers of where to start looking. A bit of background detail... What I've got is actually a header comment for part of Qt [1], specifically the Regular Expression module. My application will make Qt regular expression format accessible to the user, and I want some documentation for the syntax. At the top of Qt's implementation file is a very long comment (over 600 lines), a lot of which is a detailed explanation of the syntax, so I want to use most of that. It already has loads of mark-up, which is interpreted by Qt's documentation generator and turned into html. Given that Qt's auto-documentation syntax is a precursor to Doxygen I am assuming that they are similar enough that Doxygen can process what I've got. I am assuming that Doxygen can do this in isolation, without any source code included, as it is obviously capable of doing this kind of transformation as part of the complex html that it generates by default, and it looks like the Doxygen web-site's documentation pages are generated by Doxygen but show no source code. I am looking for more pointers on how to turn off areas that are still being generated by doxygen, and the key to why it isn't generating anything from the main comment. Regards, Richard. [1] actually Qt3. Yes, I know, "it's historical". Richard Kerry BNCS Engineer, Global Media Practice M: +44 (0)7812 325518 2nd Floor, MidCity Place, 71 High Holborn, London, WC1V 6EA ric...@at...<mailto:ric...@at...> [cid:image002.png@01D5930E.DB6E45C0] [Email-signature-banner_IBC-2019] |
From: Jonathan C. <jco...@od...> - 2019-10-16 13:20:20
|
Hello, Doxygen comments automatically my array declaration when it is on multiple lines even if there is no comments. See example below : int myArray[3] = { 0, 0, 0 } Thanks for your help, Jonathan -- Cet email a fait l'objet d'une analyse antivirus par AVG. http://www.avg.com |
From: Olivier C. <Oli...@ce...> - 2019-09-26 11:20:47
|
Hi All, In http://www.doxygen.nl/manual/index.html the top bar is fixed when one scroll the page content. How can I do that in my documentation ? Cheers, Olivier |
From: Jakob v. B. <jak...@gm...> - 2019-09-03 19:37:03
|
With regards to Swift, maybe this is of interest: https://stackoverflow.com/questions/49008780/does-doxygen-headerdoc-supports-swift-4-0 <https://stackoverflow.com/questions/49008780/does-doxygen-headerdoc-supports-swift-4-0> With regards to Kotlin, there is an outstanding feature request: https://github.com/doxygen/doxygen/issues/6629 <https://github.com/doxygen/doxygen/issues/6629> The Doxygen documentation explains pretty well which techniques you can use to make Doxygen understand new languages: * Either create a pre-parse filter that can translate the language reasonably well into one of the builtin supported languages. The technique is mentioned quite clearly, the details of making it happen are a bit terse, but in the end you’ll get it setup quickly after some fiddling around (I managed to setup a pre-filter written in Python that translates Eagle into C; in other words: you can get quite far) * Creating a filter has limitations though and only gets you so-far. It you really want full and native support, you will have to implement the relevant flex/bison files to parse the language. This technique is mentioned in the manual, but I have never been able to find more detailed information on this technique, other than that it can be done. My gut feeling regarding Swift and Kotlin is that they are different enough from supported languages that you probably want to go the flex/bison route. But my expectation is that even if you already know flex/bison very well, it may take quite some effort to figure out how to properly set it up for integration in Doxygen. But maybe someone else is aware of more technical documentation in this direction. I wish you a lot of wisdom. Sincerely, Jakob van Bethlehem > On 7 Aug 2019, at 23:42, Craig Thompson <cra...@bi...> wrote: > > Anyone have insight in how to make Doxygen support Swift and Kotlin? > > Craig Thompson > Senior Technical Writer > Big Fish Games > > _______________________________________________ > 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> |
From: <dr...@pe...> - 2019-09-02 10:01:55
|
I want to just include some text .txt files in documentation. And link them from the main index of doxygen. How can this be done? |
From: Weiss C. (AE-EB/END4) <Chr...@de...> - 2019-08-30 07:22:42
|
Hello All! I want to use a separated comment for my union which includes 2 structs and a normal element, but I don't get it working. I know there is the possibility to do the comments behind the elements but I prefer to have it separated (before) the union. Can you help me with this please? Thanks. My code consists of C and C++ and I am using doxygen version 1.8.16 on Windows. Code example: /** * @union myUnion * @brief this is my union * @var myUnion::alone * @brief this element is alone * @struct myUnion::level1 * @brief struct level one * @var myUnion::level1::first * @brief first element of first struct in union ... */ typedef union { uint8_t alone; struct { bool first; bool second; } level1; struct { uint8_t third; uint8_t forth; } level2; } myUnion; Mit freundlichen Grüßen / Best regards Christian Weiss AE-EB/END4 Tel. +49 7121 35-34028 |
From: Leonardo P. S. <Leo...@on...> - 2019-08-22 22:18:19
|
Hello All. I've downloaded the 1.8.16 version for both Windows and Linux. On windows 10, with both Python 2.7 and 3.6.8 filtering breaks file parsing, Doxygen won't even list the file, even though I do see the "Preprocessing" and "Parsing file" in the console. On a Linux VM (Ubuntu 18.04.2 LTS) with the 1.8.16 Linux binary and Python 3.6.8 everything works fi ne. I just got my machined upgraded to Windows 10, but I'm pretty sure this used to word with doxygen 1.8.15 and Python 2.7. I'll fill a bug about this issue. Thanks! From: Leonardo Pereira Santos Sent: Thursday, August 22, 2019 2:48 PM To: 'dox...@li...' <dox...@li...> Subject: Auto-link broken for filtered files? Hello All! I'm trying to fix some proprietary compiler directives by using a filter. I discovered that if I pass a file through a filter, the file documentation is generated correctly, but auto-linking seems broken! I came up with a very simple example. My filter is implemented in Python and it just opens the file and prints every single line, it doesn't change anything. I confirmed this by comparing the filter's input and output (by redirection) with a diff and there are no differences at all. I redirected the filter's output to a file called filtered_c.h. If I include this file as a source file, I get auto-link to work. If I pass the original header file through the filter, auto-linking is broken and I get a warning latex_double.md:7: warning: unable to resolve reference to `some_c_function' for \ref command If I comment out the FILTER_PATTERNS line in the Doxyfile, auto-linking works. This is really an issue for me, as I'm also supporting parsing assembly files through a filter script and I see the same behavior there: the file documentation is perfect, but no auto-linking. Any thoughts are very welcome! Thanks! This is my Doxyfile: # General options PROJECT_NAME = "Double table headers in LaTeX" INPUT = doc/latex_double.md INPUT += include/regular_c.h #INPUT += filtered_c.h #You should not need to change the rest of the file OUTPUT_DIRECTORY = output_doc GENERATE_HTML = YES GENERATE_TREEVIEW = YES GENERATE_LATEX = YES OPTIMIZE_OUTPUT_FOR_C = YES FILTER_PATTERNS += *.h="c:\Python27\python filter\dummy_filter.py" My filter is: from __future__ import print_function import sys if len(sys.argv) != 2: sys.exit(1) def extract_globals(filename): with open(filename, 'r') as infile: for line in infile: print(line, end='') extract_globals(sys.argv[1]) My Markdown source is: # Chapter Title {#chapter_title} Some text here # Introduction {#chapter_intro} Loren Ipsum @ref some_c_function And my header file is: /** * @file regular_c.h * @brief This is a simple C header file with some examples. */ #ifndef REGULAR_C_H_ #define REGULAR_C_H_ /* ---------------------------------------------------------------------------- * If building with a C++ compiler, make all of the definitions in this header * have a C binding. * ------------------------------------------------------------------------- */ #ifdef __cplusplus extern "C" { #endif /* ifdef __cplusplus */ /* ---------------------------------------------------------------------------- * Include files * --------------------------------------------------------------------------*/ /* ---------------------------------------------------------------------------- * Defines * --------------------------------------------------------------------------*/ /* ---------------------------------------------------------------------------- * Global variables and types * --------------------------------------------------------------------------*/ /** * This enumeration has the return codes for the @ref some_c_function function. */ typedef enum __SOME_C_FUNCTION_RETURN { SOME_C_FUNCTION_RETURN_everthing_ok = 0, ///< Nothing to see here SOME_C_FUNCTION_RETURN_some_weird_error, ///< This is not the error you're looking for SOME_C_FUNCTION_RETURN_some_very_bad_error, ///< This is not the error we are looking for SOME_C_FUNCTION_RETURN_life_is_sad_just_cope ///< Move along } SOME_C_FUNCTION_RETURN; /* ---------------------------------------------------------------------------- * Function prototype definitions * --------------------------------------------------------------------------*/ /** * @brief Some C function that is here just as an example. * * This function doesn't actually do anything useful. * * @param[in] v We do something with this value. * @param[out] ptr Some value will be written here. * * @return Returns a value that depends on what happened: * - @ref SOME_C_FUNCTION_RETURN_everthing_ok * Uh, everything is under control. Situation normal. * - @ref SOME_C_FUNCTION_RETURN_some_weird_error * Uh, had a slight weapons malfunction. * - @ref SOME_C_FUNCTION_RETURN_some_very_bad_error * We had a reactor leak here now. Give us a few minutes to lock it down. * Large leak... very dangerous. * - @ref SOME_C_FUNCTION_RETURN_life_is_sad_just_cope * Who is this?? What's your operating number? * */ int some_c_function(uint32_t v, void* ptr); /* ---------------------------------------------------------------------------- * Close the 'extern "C"' block * ------------------------------------------------------------------------- */ #ifdef __cplusplus } #endif /* ifdef __cplusplus */ #endif /* REGULAR_C_H_ */ Any thoughts are very welcome! Thanks! Regards, ____________________________________________________________ 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...> |
From: Leonardo P. S. <Leo...@on...> - 2019-08-22 18:48:13
|
Hello All! I'm trying to fix some proprietary compiler directives by using a filter. I discovered that if I pass a file through a filter, the file documentation is generated correctly, but auto-linking seems broken! I came up with a very simple example. My filter is implemented in Python and it just opens the file and prints every single line, it doesn't change anything. I confirmed this by comparing the filter's input and output (by redirection) with a diff and there are no differences at all. I redirected the filter's output to a file called filtered_c.h. If I include this file as a source file, I get auto-link to work. If I pass the original header file through the filter, auto-linking is broken and I get a warning latex_double.md:7: warning: unable to resolve reference to `some_c_function' for \ref command If I comment out the FILTER_PATTERNS line in the Doxyfile, auto-linking works. This is really an issue for me, as I'm also supporting parsing assembly files through a filter script and I see the same behavior there: the file documentation is perfect, but no auto-linking. Any thoughts are very welcome! Thanks! This is my Doxyfile: # General options PROJECT_NAME = "Double table headers in LaTeX" INPUT = doc/latex_double.md INPUT += include/regular_c.h #INPUT += filtered_c.h #You should not need to change the rest of the file OUTPUT_DIRECTORY = output_doc GENERATE_HTML = YES GENERATE_TREEVIEW = YES GENERATE_LATEX = YES OPTIMIZE_OUTPUT_FOR_C = YES FILTER_PATTERNS += *.h="c:\Python27\python filter\dummy_filter.py" My filter is: from __future__ import print_function import sys if len(sys.argv) != 2: sys.exit(1) def extract_globals(filename): with open(filename, 'r') as infile: for line in infile: print(line, end='') extract_globals(sys.argv[1]) My Markdown source is: # Chapter Title {#chapter_title} Some text here # Introduction {#chapter_intro} Loren Ipsum @ref some_c_function And my header file is: /** * @file regular_c.h * @brief This is a simple C header file with some examples. */ #ifndef REGULAR_C_H_ #define REGULAR_C_H_ /* ---------------------------------------------------------------------------- * If building with a C++ compiler, make all of the definitions in this header * have a C binding. * ------------------------------------------------------------------------- */ #ifdef __cplusplus extern "C" { #endif /* ifdef __cplusplus */ /* ---------------------------------------------------------------------------- * Include files * --------------------------------------------------------------------------*/ /* ---------------------------------------------------------------------------- * Defines * --------------------------------------------------------------------------*/ /* ---------------------------------------------------------------------------- * Global variables and types * --------------------------------------------------------------------------*/ /** * This enumeration has the return codes for the @ref some_c_function function. */ typedef enum __SOME_C_FUNCTION_RETURN { SOME_C_FUNCTION_RETURN_everthing_ok = 0, ///< Nothing to see here SOME_C_FUNCTION_RETURN_some_weird_error, ///< This is not the error you're looking for SOME_C_FUNCTION_RETURN_some_very_bad_error, ///< This is not the error we are looking for SOME_C_FUNCTION_RETURN_life_is_sad_just_cope ///< Move along } SOME_C_FUNCTION_RETURN; /* ---------------------------------------------------------------------------- * Function prototype definitions * --------------------------------------------------------------------------*/ /** * @brief Some C function that is here just as an example. * * This function doesn't actually do anything useful. * * @param[in] v We do something with this value. * @param[out] ptr Some value will be written here. * * @return Returns a value that depends on what happened: * - @ref SOME_C_FUNCTION_RETURN_everthing_ok * Uh, everything is under control. Situation normal. * - @ref SOME_C_FUNCTION_RETURN_some_weird_error * Uh, had a slight weapons malfunction. * - @ref SOME_C_FUNCTION_RETURN_some_very_bad_error * We had a reactor leak here now. Give us a few minutes to lock it down. * Large leak... very dangerous. * - @ref SOME_C_FUNCTION_RETURN_life_is_sad_just_cope * Who is this?? What's your operating number? * */ int some_c_function(uint32_t v, void* ptr); /* ---------------------------------------------------------------------------- * Close the 'extern "C"' block * ------------------------------------------------------------------------- */ #ifdef __cplusplus } #endif /* ifdef __cplusplus */ #endif /* REGULAR_C_H_ */ Any thoughts are very welcome! Thanks! Regards, ____________________________________________________________ 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...> |
From: Ryan S. E. <rel...@um...> - 2019-08-13 12:56:18
|
Hello, Just wanted to follow up on this. We found the bug (a single missing character in a regex). A PR has been opened on github https://github.com/doxygen/doxygen/pull/7192 Cheers, Ryan On Thu, 31 Jan 2019, Ryan S. Elliott wrote: > Hi Travis, > > Thanks for your reply! This all sounds reasonable. I won't be able to > dig-in to this right away, but I'll put it on my list to get back to soon. > > Thanks, > > Ryan > > On Thu, 31 Jan 2019, Travis Everett wrote: > >> Ryan, >> >> I don't know a ton about how those parts of the codebase work so I stalled >> a bit hoping someone else would respond (there's some chance I'll mis-lead >> you here...). In any case, a good place to start is by seeing whether the >> behavior changed in 1.8.12/13/14. That should let you narrow your focus to >> just commits in a single version. >> >> If you aren't set up to build Doxygen from source (and/or aren't >> comfortable doing so), it's probably fine to open an issue report with the >> behavior you've seen, which version changed it, and a minimal set of >> files/config necessary to reproduce it. If you are comfortable building >> from source you can push this further and identify the specific commit. >> >> Hopefully the issue you're seeing was caused by an update to >> src/fortranscanner.i or src/fortrancode.i (there are probably only a few >> commits touching those per version). You can use git or github to identify >> which commits between two versions touched either of those files, and >> recompile/rebuild (depending on how long your docs take to build you may be >> able to speed this up a lot by making a separate config that just includes >> the minimum set of files you need to see the behavior) at each to see which >> introduces the break. >> >> If that doesn't work (or if there are more commits than I suspect touching >> those two files) you can use the more general git bisect command (along >> with a recompile and rebuild doc cycle) to narrow it down to the last-good >> commit. >> >> An issue report that identifies the commit/PR introducing the error should >> make it a quicker fix; if you're thinking of tackling the fix itself but >> need help figuring out where to start, it may help to fish around on the >> separate development list >> >> HTH, >> Travis >> >> >> On Wed, Jan 30, 2019 at 5:51 PM Ryan S. Elliott <rel...@um...> wrote: >> >>> Hello, >>> >>> Thanks for the reply. >>> >>> I tried 1.8.11 on my mac and I get a Segmentation fault! >>> >>> . >>> . >>> . >>> Reading >>> /Users/relliott/unison-sync/KIM/git/kim-api/fortran/include/kim_model_compute_arguments_module.f90... >>> Parsing file >>> /Users/relliott/unison-sync/KIM/git/kim-api/fortran/include/kim_model_compute_arguments_module.f90... >>> /bin/sh: line 1: 54543 Segmentation fault: 11 >>> /Users/relliott/doxygen/build/bin/doxygen >>> /Users/relliott/unison-sync/KIM/git/kim-api/build/docs/Doxyfile.docs >>> >>> >>> Anyway, then I set up a ubuntu VM and got it to work. Indeed, 1.8.11 on >>> ubuntu >>> it seems I get the same output as RTD. I've also confirmed that 1.8.14 on >>> ubuntu produces the same output (without the interfaces documented) that I >>> previously obtained on my mac. >>> >>> >>> So, it seems that this is a regression in behavior from 1.8.11 to 1.8.14? >>> How >>> should I go about figuring out when/where this happened and what to do >>> about >>> it? >>> >>> >>> >>> On Wed, 30 Jan 2019, Travis Everett wrote: >>> >>>> The copy on RTD indicates it was generated by doxygen 1.8.11, while the >>> one >>>> at openkim indicates 1.8.14; a good first step would be installing 1.8.11 >>>> and seeing if your output matches what's on RTD. >>>> >>>> On Wed, Jan 30, 2019 at 3:08 PM Ryan S. Elliott <rel...@um...> >>> wrote: >>>> >>>>> Hello, >>>>> >>>>> I'm working on the doxygen documentation for the kim-api project >>>>> (https://github.com/openkim/kim-api) >>>>> >>>>> When I locally (on my mac) generate the doxygen docs I see problems with >>>>> the >>>>> fortran docs. In particular, there are a fair number of functions that >>>>> are not >>>>> automatically documented by the parser. Further, no generic interfaces >>> are >>>>> documented. >>>>> >>>>> However, the exact same git commit, when used to generate the doxygen >>> docs >>>>> by >>>>> readthedocs documents all the functions and generates the generic >>> interface >>>>> docs. >>>>> >>>>> Here is a link to a readthedocs page showing the interfaces: >>>>> >>> https://kim-api.readthedocs.io/en/latest/namespacekim__model__module.html >>>>> >>>>> Here is a link to a similar page generated locally: >>>>> >>> https://openkim.org/kim-api/docs-beta.3/namespacekim__model__module.html >>>>> >>>>> In particular, also notice that in the locally generated docs the >>>>> "kim_model_is_routine_present" function is not documented! >>>>> >>>>> >>>>> I can't understand why these differences are occuring. Can anyone point >>>>> me in >>>>> the right direction? >>>>> >>>>> >>>>> Thanks, >>>>> >>>>> Ryan Elliott >>>>> >>>>> >>>>> _______________________________________________ >>>>> Doxygen-users mailing list >>>>> Dox...@li... >>>>> https://lists.sourceforge.net/lists/listinfo/doxygen-users >>>>> >>>> >>> >>> -- >>> Ryan S. Elliott, Ph.D. and Professor >>> Aerospace Engineering & Mechanics, University of Minnesota >>> (612) 624-2376 (626-1558 fax) >>> https://z.umn.edu/relliott >>> download vCard <https://z.umn.edu/relliott_vcf> >>> ---------- >>> The distinction between past, present and future, is only an illusion, >>> even >>> if a stubborn one. >>> >>> Albert >>> Einstein >>> ---------- >>> >> > > -- Ryan S. Elliott, Ph.D. and Professor Aerospace Engineering & Mechanics, University of Minnesota (612) 624-2376 (626-1558 fax) https://z.umn.edu/relliott download vCard <https://z.umn.edu/relliott_vcf> ---------- Words ought to be a little wild for they are the assaults of thought on the unthinking. John Maynard Keynes ---------- |
From: Leonardo P. S. <Leo...@on...> - 2019-08-09 19:46:01
|
Hello All! I’m organizing my source files under different groups, some of which have subgroups. I’ve noticed that nested groups work in the HTML output, but get flattened in the LaTeX output. HTML output: Modules<modules.html> Nested Groups<index.html> · ▼<javascript:void(0)>Modules<modules.html> o ▼<javascript:void(0)>Some big group<group___b_i_g_g_r_o_u_p.html> § ▼<javascript:void(0)>A small group<group___s_m_a_l_l_g_r_o_u_p.html> § some_yet_another_c_function<group___s_m_a_l_l_g_r_o_u_p.html#ga324420a3ea1c330055df10ae4974ca4b> Modules Here is a list of all modules: [detail level 12] ▼Some big group<group___b_i_g_g_r_o_u_p.html> A small group<group___s_m_a_l_l_g_r_o_u_p.html> LaTeX output: 3 Module Documentation 5 3.1 Some big group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 3.1.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 3.2 A small group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 3.2.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 3.2.2 Function Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 3.2.2.1 some_yet_another_c_function() . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Small Group should be under Some Big Group as 3.1.1, instead it get a section of it’s own. Should I file this as a bug? Thanks!! Doxyfile: # General options PROJECT_NAME = "Nested Groups" INPUT = include/nested.h #You should not need to change the rest of the file OUTPUT_DIRECTORY = output_doc GENERATE_HTML = YES GENERATE_TREEVIEW = YES GENERATE_LATEX = YES OPTIMIZE_OUTPUT_FOR_C = YES nested.h /** * @file nested.h * @brief Nested groups example */ #ifndef SRC_NESTED_H_ #define SRC_NESTED_H_ /** @defgroup BIGGROUP Some big group * @{ */ /** @defgroup SMALLGROUP A small group * @{ */ /** * \brief We should have a real explanation here. * * This function **WILL BE** included as the key `DO_NOT_INCLUDE_THIS` is not * present in the [ENABLED_SECTIONS](http://www.doxygen.nl/manual/config.html#cfg_enabled_sections) option. * * \return Just 0 */ int some_yet_another_c_function(void); /** @} */ /** @} */ #endif /* SRC_NESTED_H_ */ ____________________________________________________________ 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...> |
From: Leonardo P. S. <Leo...@on...> - 2019-08-07 22:25:08
|
Hello All! I'm trying to get in LaTeX that nice rendering of code examples Doxygen creates dfor the HTML output. Specifically, I'm trying to place the code examples inside a box with a light gray background. I'm re-defining the DoxyCode environment, and for code examples, in Markdown it works perfectly. But for the @example directive, the code is placed inside a DoxyParagraph, which is a list. This makes the DoxyParagraph's title and the code to overlap in the resulting PDF. >From what I could gather, the code is not inserted as a block, but each line is inserted as a \DoxyCodeLine. Any ideas on how to make the LaTeX code examples look similar as they do in the HTML output? Thank you! My Doxycode style is \renewenvironment{DoxyCode}[1]{% \vspace{\fontcharht\font`A} \par% \scriptsize% \normalfont\ttfamily% \rightskip0pt plus 1fil% \settowidth{\DoxyCodeWidth}{000000}% \settowidth{\CodeWidthChar}{?}% \settoheight{\CodeHeightChar}{?}% \setlength{\parskip}{0ex plus 0ex minus 0ex}% \ifthenelse{\equal{#1}{0}} { {\lccode`~32 \lowercase{\global\let~}\NiceSpace}\obeyspaces% } { {\lccode`~32 \lowercase{\global\let~}}\obeyspaces% } \begin{tabular}{|>{\columncolor[gray]{0.9}}p{0.9\textwidth}|}% \hline\\% }{% \\\\\hline% \end{tabular}% \normalfont% \normalsize% \settowidth{\CodeWidthChar}{?}% \settoheight{\CodeHeightChar}{?}% } ____________________________________________________________ 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...> |
From: Craig T. <cra...@bi...> - 2019-08-07 21:58:34
|
Anyone have insight in how to make Doxygen support Swift and Kotlin? Craig Thompson Senior Technical Writer Big Fish Games |
From: Leonardo P. S. <Leo...@on...> - 2019-08-07 20:13:03
|
Hello All! I just discovered that things work if I define an anchor with the title: ### Some Section {#some_section_label} If I just use ### Some Section The title gets rendered correctly, but it’s not included in the TOC, HTML treeview, etc. Regards, From: Leonardo Pereira Santos Sent: August-02-19 6:26 PM To: dox...@li... Subject: Structured elements in Markdown Hello All! I just discovered that using Markdown will not generate a proper section with Doxygen. My Markdown file is: # Introduction {#introduction_anchor} ## Purpose lalalala The ‘Introduction’ gets translated to a chapter title, which is pretty cool. I expected the ‘Purpose’ header2 to be translated as a section. But the HTML/PDF output is just Top<index.html> Title * Introduction<index.html> * Second Chapter<second_chapter_anchor.html> There’s no ‘Purpose’ under ‘Introduction’. If I use Doxygen’s \section, I get the desired result in both HTML and LaTeX. Top<index.html> Title * ▼<javascript:void(0)>Introduction<index.html> o Purpose<index.html#sec> Is this by design? Thank you. ____________________________________________________________ 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...> |
From: Leonardo P. S. <Leo...@on...> - 2019-08-06 21:20:32
|
Hello All! I'm using a custom layout file with most sections with visible="No". One example is , which controls whether "Data Structures<annotated.html>" is visible: <tab type="classes" visible="no" title=""> In the HTML output, there's no "Data Structures", but the LaTeX output still has \chapter{Data Structure Documentation} And \chapter{Data Structure Documentation} I'm also setting ALPHABETICAL_INDEX = NO in my Doxyfile. Thanks! ____________________________________________________________ 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...> |
From: Leonardo P. S. <Leo...@on...> - 2019-08-06 17:24:43
|
Stefan, Thank you very much for your help. I should have looked more closely into the template Doxyfile. Thanks again. Leonardo -----Original Message----- From: Stefan Pendl [mailto:ste...@gm...] Sent: August-03-19 1:31 AM To: dox...@li... Subject: Re: [Doxygen-users] Full file path in Latex TOC [External Email]: This email arrived from an external source - Please exercise caution when opening any attachments or clicking on links. Am 02.08.2019 um 22:44 schrieb Leonardo Pereira Santos: > > But the LaTeX output uses the full path of a file as the section name. > This is the ToC: > > 6.7 > C:/some/deep/folder/projects/lalala/firmware/Cortex-M3/cmsis/include/sk5.h > File Reference . . . . . . . 38 > See the settings FULL_PATH_NAMES, STRIP_FROM_PATH and STRIP_FROM_INC_PATH. Use "doxygen -g ..." or "doxygen -w ..." to get a full settings file with explanations of all defaults, see the documentation for further help on the command line switches. -- *Stefan P.* Top-posting: A: Because it messes up the order in which people normally read text. Q: Why is top-posting such a bad thing? A: Top-posting. Q: What is the most annoying thing in e-mail? _______________________________________________ Doxygen-users mailing list Dox...@li... https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.sourceforge.net_lists_listinfo_doxygen-2Dusers&d=DwICAg&c=MHZppzMdXMt3JYjCV71UsQ&r=k8KpFgIlnqWJ_UCMIorh7Kaa71fn5J46EO16Eh-Dgx5RVhccwhWRNbrzEpx0RhhR&m=8kvelVEUfxJi8SFV94gaYJnJgLPdvA29KwAXQ2Qvl3s&s=7TnqXzx4CUmuY6X98kbR9RejqiFFHeXHHj3Vcfr6w8U&e= |
From: Stefan P. <ste...@gm...> - 2019-08-03 05:31:28
|
Am 02.08.2019 um 22:44 schrieb Leonardo Pereira Santos: > > But the LaTeX output uses the full path of a file as the section name. > This is the ToC: > > 6.7 > C:/some/deep/folder/projects/lalala/firmware/Cortex-M3/cmsis/include/sk5.h > File Reference . . . . . . . 38 > See the settings FULL_PATH_NAMES, STRIP_FROM_PATH and STRIP_FROM_INC_PATH. Use "doxygen -g ..." or "doxygen -w ..." to get a full settings file with explanations of all defaults, see the documentation for further help on the command line switches. -- *Stefan P.* Top-posting: A: Because it messes up the order in which people normally read text. Q: Why is top-posting such a bad thing? A: Top-posting. Q: What is the most annoying thing in e-mail? |
From: Leonardo P. S. <Leo...@on...> - 2019-08-02 22:25:59
|
Hello All! I just discovered that using Markdown will not generate a proper section with Doxygen. My Markdown file is: # Introduction {#introduction_anchor} ## Purpose lalalala The ‘Introduction’ gets translated to a chapter title, which is pretty cool. I expected the ‘Purpose’ header2 to be translated as a section. But the HTML/PDF output is just Top<index.html> Title * Introduction<index.html> * Second Chapter<second_chapter_anchor.html> There’s no ‘Purpose’ under ‘Introduction’. If I use Doxygen’s \section, I get the desired result in both HTML and LaTeX. Top<index.html> Title * ▼<javascript:void(0)>Introduction<index.html> o Purpose<index.html#sec> Is this by design? Thank you. ____________________________________________________________ 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...> |
From: Leonardo P. S. <Leo...@on...> - 2019-08-02 20:44:58
|
Hello All! When generating HTML output, the file view uses a nice relative path, like so: ▼ Cortex-M3<dir_a938ad93c16dc5075a84924e3b018bd3.html> ▼ cmsis<dir_222b2f2fe9448e289ea2538e98b9d1bc.html> ▼ include<dir_d3add8f476ef2ccbe77ba1141fddbbd0.html> sk5.h<sk5_8h.html> Hardware register abstraction layer for the SOC But the LaTeX output uses the full path of a file as the section name. This is the ToC: 6.7 C:/some/deep/folder/projects/lalala/firmware/Cortex-M3/cmsis/include/sk5.h File Reference . . . . . . . 38 6.7.1 Detailed Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 And the PDF output: 6.7 C:/SOME/FOLDER/PROJECTS/LALALA/FIRMWARE/CORTEX-M3/CMSIS/INCLUDE/SK5.H FILE REFERENCE Is there a way to customize this using LATEX_HEADER or LATEX_EXTRA_STYLESHEET, so a relative path is used? I could not find a style/variable/whatever that would control section’s names. Thanks!! ____________________________________________________________ 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...> |
From: Leonardo P. S. <Leo...@on...> - 2019-08-02 20:34:39
|
Paolo, Thank you for your reply. Turns out, it was (obviously) my fault. \uppercase{\chaptertitlename} Need braces. And you should not use it anyway. Using \MakeUppercase solves my problems. https://tex.stackexchange.com/questions/502570/error-with-uppercase-in-titlesecs-label-field/502572#502572 Thanks again! -----Original Message----- From: Paolo Gai [mailto:pj...@ev...] Sent: August-02-19 12:53 AM To: Leonardo Pereira Santos <Leo...@on...>; dox...@li... Subject: Re: [Doxygen-users] Doxygen LaTeX output broken with MikTeX 2.9.7100 [External Email]: This email arrived from an external source - Please exercise caution when opening any attachments or clicking on links. Dear Leonardo, > Has anyone experienced problems with the LaTeX output and MikTeX > 2.9.7100? When trying to generate the PDF output from the LaTeX output, > I'm getting several errors like this:[...] We had a similar issue, please see this message: https://urldefense.proofpoint.com/v2/url?u=https-3A__sourceforge.net_p_doxygen_mailman_message_36523775_&d=DwID-g&c=MHZppzMdXMt3JYjCV71UsQ&r=k8KpFgIlnqWJ_UCMIorh7Kaa71fn5J46EO16Eh-Dgx5RVhccwhWRNbrzEpx0RhhR&m=PnT9U86Nrr0kAnImSZ2Q_jCYfj1NwYoI_RBPgG0hlys&s=k20Wk-STL0q4axuAnZDyG9qwIYWDmRd4hxCAVWYN9V4&e= It seems that miktex has a newer version of the longtabu package than Ubuntu. Please check of the problem you have is also linked to the usage of the longtabu package or if it is due to something else. Ciao, PJ |
From: Getz, R. <Rob...@an...> - 2019-08-02 17:58:45
|
Hi. I'm trying to create some doc to help some new developers get familiar with a fairly large c++ codebase using Doxygen version 1.8.13. Everything works great with the c++ things - I'm just stuck getting some of the user focused markup (readme.md) files included properly with their images. In the code base, images are maintained in separate directories from the md files, and Doxygen doesn't seem to follow the relative paths (or at least doesn't the way I have things configured). I have the image path defined to : IMAGE_PATH = /home/rgetz/github/sdrangel_upstream/doc/img/ /home/rgetz/github/sdrangel_upstream/sdrbase/resources/webapi/ /home/rgetz/github/sdrangel_upstream/sdrbase/resources/webapi/doc/swagger-ui/ /home/rgetz/github/sdrangel_upstream/sdrgui/resources/ Where are the actual images are (For example) https://github.com/f4exb/sdrangel/tree/master/doc/img This works in the top level Readme.md https://github.com/f4exb/sdrangel/blob/master/Readme.md  This gets pick up, and found, and that gets translated into html: <img src="sdrangel_banner.png" alt="sdrangel_banner.png"/> And the file gets copied over into the html_output directory: file dev_docs/sdrangel_banner.png dev_docs/sdrangel_banner.png: PNG image data, 904 x 314, 8-bit/color RGBA, non-interlaced But leaf readme.md in directories down https://github.com/f4exb/sdrangel/blob/master/plugins/channelrx/chanalyzer/readme.md in the md, uses:  So that it renders properly on the drive, and on github. Via Doxygen, the html renders to: <div class="image"> <img src="../../../doc/img/ChAnalyzerNG_plugin_settings.png" alt="Channel Analyzer NG plugin controls"/> </div> That that doesn't display properly (gets a broken image). I have tried a few things, including setting the image_path to other directories, so that the relative path would work. For example: IMAGE_PATH = /home/rgetz/github/sdrangel_upstream/plugins/channelrx/chanalyzer/ Should work with: plugins/channelrx/chanalyzer/../../../ doc/img/ChAnalyzerNG_plugin_settings.png But that doesn't seem to work either. Any pointers? Thanks -Robin |
From: Diego M. D. <die...@gm...> - 2019-08-02 13:08:10
|
Hi all, Should this be relevant for you, see problem resolution at https://github.com/doxygen/doxygen/issues/7127 Best regards, Diego On Thu, 25 Apr 2019 at 15:43, Diego Machado Dias <die...@gm...> wrote: > Dear all, > > While browsing the documentation of L4Re (https://l4re.org/doc/), which > is generated using Doxygen, I noticed that the link for the documentation > of some C++ classes in the search bar is broken. This seems to happen in > some cases where there are multiple interfaces with the same name. For > example, while searching for 'Task', two results come out in the search > bar. Clicking on the first takes the user to the C interface, while > clicking on the second result takes no effect. > > I thought this could be related to the fact that the name 'Task' is used > to name two interfaces (one in C, one in C++), but then I noticed that both > the C++ and C interfaces for Factory are both named 'Factory', and there > the links for each individual interface work as expected. > > Looking into the html code of the page in the Chrome DevTools, I noticed > that when searching for 'Factory' (which is the case where the link > actually works), if I click over the link in the result panel in the search > bar, it updates the SRChildren element adding the attribute: > > style="display: block;" > > This does not happen when I search for 'Task'. Two results appear, but > only one of the links has an effect when clicked on. I also noticed that if > I manually edit the content of the page in Chrome DevTools by adding > > style="display: block;" > > to > > <div class="SRChildren" classname="SRChildren"> > > then it expands the sub-menu and shows the link for the Task class > documentation. > > Looking at the source codes for both classes (Factory/Task), I could not > spot anything that was able to justify this behaviour. I wonder if this is > a bug in Doxygen, or may it be some configuration missing on the source > code of L4Re which is causing the link to be broken. > > > Link for the sources (Task C/C++ and Factory C/C++) are given here: > > - Task C++ Interface > > [In Doxygen] https://l4re.org/doc/task_source.html > [In Github] > https://github.com/kernkonzept/l4re-core/blob/master/l4sys/include/task > > > - Task C interface > > [In Doxygen] https://l4re.org/doc/task_8h_source.html > > [In Github] > https://github.com/kernkonzept/l4re-core/blob/master/l4sys/include/task.h > > > > - Factory C++ Interface > > [In Doxygen] https://l4re.org/doc/factory_source.html > > [In Github] > https://github.com/kernkonzept/l4re-core/blob/master/l4sys/include/factory > > > > - Factory C Interface > > [In Doxygen] https://l4re.org/doc/factory_8h_source.html > > [In Github] > https://github.com/kernkonzept/l4re-core/blob/master/l4sys/include/factory.h > > > > I've tried compile the documentation myself with two versions of Doxygen: > 1.8.13 and 1.8.15 (the latest), but I saw no difference with respect to the > broken link. > > Kind regards, > Diego Machado Dias > > |
From: Paolo G. <pj...@ev...> - 2019-08-02 05:16:57
|
Dear Leonardo, > Has anyone experienced problems with the LaTeX output and MikTeX > 2.9.7100? When trying to generate the PDF output from the LaTeX output, > I’m getting several errors like this:[...] We had a similar issue, please see this message: https://sourceforge.net/p/doxygen/mailman/message/36523775/ It seems that miktex has a newer version of the longtabu package than Ubuntu. Please check of the problem you have is also linked to the usage of the longtabu package or if it is due to something else. Ciao, PJ |