doxygen-users Mailing List for Doxygen (Page 2)
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
|
Dec
|
From: Jim O. <jim...@gm...> - 2023-07-26 14:41:26
|
Using doxygen version 1.9.5, the documenation for my C++ project builds. After upgrading to version 1.9.7, I get the error: "Specified markdown page mainpage 'mainpage.md' does not exist" Well, that file does exist, and its contents are placed into index.html when doxygen runs. And yes, I deleted all generated documenation before rerunning doxygen. Windows 11 ARM inside a VMWare Fusion virtual machine on M1 Macbook. I have two Windows 11 virtual machines and both do this. I am hoping this is something obvious so that I do not have to generate a sample project to show this. Thanks in advance for any help. |
From: Richard D. <Richard@Damon-Family.org> - 2023-07-14 03:18:29
|
On 7/13/23 5:23 PM, via Doxygen-users wrote: > I'm using doxygen to create state machine diagrams from my C code. This works great, I can create a comment block like this, run doxygen / graphwiz, and get a html file with the diagram: > > /*! > \dot > digraph my_state_machine { > rankdir=LR; > size="8,5" > > init -> start [ label = "" ]; > start -> continue [ label = "" ]; > continue -> stop[ label = "" ]; > stop -> start [ label = "" ]; } > \enddot > */ > > Now I would like to be able in interleave doxygen comments with my code, so the documentation and the corresponding code are closer together. I would like to split the above diagram like this: > > /*! \dot digraph my_state_machine { rankdir=LR; size="8,5" } \enddot */ > uint8_t mystate = ST_INIT; > while 1 > { > switch (myState) > { > case ST_INIT: > { > /*! \dot digraph my_state_machine { init -> start [ label = "" ]; } \enddot */ > myState = ST_START; > break; > } > case ST_START: > { > /*! \dot digraph my_state_machine { start -> continue [ label = "" ]; } \enddot */ > myState = ST_CONTINUE; > break; > } > case ST_CONTINUE: > { > /*! \dot digraph my_state_machine { continue -> stop [ label = "" ]; } \enddot */ > myState = ST_STOP; > break; > } > case ST_STOP: > { > /*! \dot digraph my_state_machine { stop -> start [ label = "" ]; } \enddot */ > myState = ST_START; > break; > } > } > } > > Is there any filter that can take fragments of the digraph diagram, assemble it, and then feed it to doxygen, so doxygen can feed it into graphwiz/dot? > Can doxygen be extended to be able to assemble \dot fragments? > One thought to try,( not at a setup to test this right now), use /// comments like: /// \dot digraph my_state_machine { rankdir=LR; size="8,5" } \enddot uint8_t mystate = ST_INIT; /// while 1 /// { /// switch (myState) /// { /// case ST_INIT: /// { /// /// \dot digraph my_state_machine { init -> start [ label = "" ]; } \enddot myState = ST_START; /// break; /// } /// case ST_START: /// { /// /// \dot digraph my_state_machine { start -> continue [ label = "" ]; } \enddot myState = ST_CONTINUE; /// break; /// } /// case ST_CONTINUE: /// { /// /// \dot digraph my_state_machine { continue -> stop [ label = "" ]; } \enddot myState = ST_STOP; /// break; /// } /// case ST_STOP: /// { /// /// \dot digraph my_state_machine { stop -> start [ label = "" ]; } \enddot */ myState = ST_START; /// break; /// } /// } /// } /// Since every line has a comment, the documenting comment block should continue -- Richard Damon |
From: <Ced...@ec...> - 2023-07-13 21:39:19
|
I'm using doxygen to create state machine diagrams from my C code. This works great, I can create a comment block like this, run doxygen / graphwiz, and get a html file with the diagram: /*! \dot digraph my_state_machine { rankdir=LR; size="8,5" init -> start [ label = "" ]; start -> continue [ label = "" ]; continue -> stop[ label = "" ]; stop -> start [ label = "" ]; } \enddot */ Now I would like to be able in interleave doxygen comments with my code, so the documentation and the corresponding code are closer together. I would like to split the above diagram like this: /*! \dot digraph my_state_machine { rankdir=LR; size="8,5" } \enddot */ uint8_t mystate = ST_INIT; while 1 { switch (myState) { case ST_INIT: { /*! \dot digraph my_state_machine { init -> start [ label = "" ]; } \enddot */ myState = ST_START; break; } case ST_START: { /*! \dot digraph my_state_machine { start -> continue [ label = "" ]; } \enddot */ myState = ST_CONTINUE; break; } case ST_CONTINUE: { /*! \dot digraph my_state_machine { continue -> stop [ label = "" ]; } \enddot */ myState = ST_STOP; break; } case ST_STOP: { /*! \dot digraph my_state_machine { stop -> start [ label = "" ]; } \enddot */ myState = ST_START; break; } } } Is there any filter that can take fragments of the digraph diagram, assemble it, and then feed it to doxygen, so doxygen can feed it into graphwiz/dot? Can doxygen be extended to be able to assemble \dot fragments? ________________________________________________________ Your E-Mail. Your Cloud. Your Office. eclipso Mail & Cloud. https://www.eclipso.eu |
From: meator <mea...@gm...> - 2023-07-09 17:35:51
|
Hi. I have the following two classes in my code: ``` template <class, class = void> struct is_printable : std::false_type { }; /** * @brief Type trait that indicates if class is printable. * * This type trait indicates that type _T_ is printable i.e. `os << val` is a * valid expression (where `os` is a instance of `std::ostream` or one of it's * subclasses and `val` is a instance of _T_). */ template <class T> struct is_printable< T, std::void_t<decltype(std::declval<std::ostream>() << std::declval<T>())>> : std::true_type { }; ``` When I try to write `@ref is_printable` somewhere else in the documentation, the link points to the first class that contains no documentation. I want to link to the second class. But that's complicated (and pretty impractical). I have tried @ref is_printable<T, std::void_t<decltype(std::declval(std::ostream)() << std::declval(T)())>> but it picked up only the 'is_printable' part which (again) linked to the first class. How can I link to the second class? |
From: Mark <dox...@er...> - 2023-07-02 11:02:19
|
I have several documents I am linking together with the help of a tag file. I have the tag file set up and working so that `@ref otherdocspage` in a document gives the correct reference to the external document in the generated output. I am also customizing the layout via DOXYGEN_LAYOUT_FILE. If I write a navindex tab entry like <tab type="user" url="@ref otherdocspage" title=“License"/> the url on the link in the tab points to otherdocspage.html in the document to which the layout file is being applied. Is there a way of writing “url” to make it aware of the tag file or some way to make the customized layout.xml aware of the tag file? Or is what I am trying to do impossible? Regards -Mark |
From: Liviu I. <il...@li...> - 2023-06-01 21:45:01
|
> On 1 Jun 2023, at 21:55, Dimitri van Heesch <do...@gm...> wrote: > > Hi Luviu, > > A similar issue has been reported and fixed, see > https://github.com/doxygen/doxygen/issues/10089 > > If you think your issue is different, please file a new issue and include a self-contained example. Frankly I'm not sure if this is the same issue or not, since, from the documentation, I did not understand what is the recommended way to control the URLs. Can you confirm that a definition like ``` # Section name {#label} ``` should be reflected in a URL like .../label.html, regardless the actual name of the markdown file where the definition is located? I could not find in the documentation anything about the relationship between these custom labels and URLs. If the info is there and I missed it, can you point me to the right page? Thank you, Liviu |
From: Dimitri v. H. <do...@gm...> - 2023-06-01 18:55:52
|
Hi Luviu, A similar issue has been reported and fixed, see https://github.com/doxygen/doxygen/issues/10089 If you think your issue is different, please file a new issue and include a self-contained example. Regards, Dimitri > On 29 May 2023, at 22:56, Liviu Ionescu <il...@li...> wrote: > > Hi, > > Is there any trick to control the URLs of static pages? > > In my case I have a Getting Started file named `install.md`, which gets `md_website_2pages_2install.html`, not exactly intuitive, not to mention that it changed from 1.9.6 to 1.9.7. > > The reason I stumbled upon it is that in my home page I have to use some plain HTML code, and I cannot use doxygen primitives, I need to enter the actual URL in some links. > > Ideally this would be done with something like `@permalink 'getting-started'` in the install.md file, which would generate a page named exactly `getting-started.html`, and linking to it from html would be easy. > > > Thank you, > > Liviu > > > > > _______________________________________________ > Doxygen-users mailing list > Dox...@li... > https://lists.sourceforge.net/lists/listinfo/doxygen-users |
From: Liviu I. <il...@li...> - 2023-05-29 21:26:35
|
Hi, Is there any trick to control the URLs of static pages? In my case I have a Getting Started file named `install.md`, which gets `md_website_2pages_2install.html`, not exactly intuitive, not to mention that it changed from 1.9.6 to 1.9.7. The reason I stumbled upon it is that in my home page I have to use some plain HTML code, and I cannot use doxygen primitives, I need to enter the actual URL in some links. Ideally this would be done with something like `@permalink 'getting-started'` in the install.md file, which would generate a page named exactly `getting-started.html`, and linking to it from html would be easy. Thank you, Liviu |
From: Dimitri v. H. <do...@gm...> - 2023-05-28 14:31:47
|
Hi Nicolas, I've repackaged the tarball without any special attributes here: https://www.doxygen.nl/files/doxygen-1.9.7.repack.src.tar.gz Can you try this? See also https://github.com/doxygen/doxygen/issues/10094 Regards, Dimitri > On 28 May 2023, at 15:41, Nicolas Fournaux <ve...@gm...> wrote: > > Hello, > > I need to install PHP with brew (I use macos) and doxygen is a dependency of php. > > Anyway, I need it, but brew can't install it because it says : > > https://doxygen.nl/files/doxygen-1.9.7.src.tar.gz > tar: Ignoring malformed pax extended attribute > tar: Ignoring malformed pax extended attribute > tar: Error exit delayed from previous errors. > > When I download directly https://doxygen.nl/files/doxygen-1.9.7.src.tar.gz I also get those error when I try to tar xzf the package. > > Could you fix it ? Because now nobody can install PHP 8.1 anymore with brew :( > > Thanks > _______________________________________________ > Doxygen-users mailing list > Dox...@li... > https://lists.sourceforge.net/lists/listinfo/doxygen-users |
From: Nicolas F. <ve...@gm...> - 2023-05-28 13:42:05
|
Hello, I need to install PHP with brew (I use macos) and doxygen is a dependency of php. Anyway, I need it, but brew can't install it because it says : https://doxygen.nl/files/doxygen-1.9.7.src.tar.gz tar: Ignoring malformed pax extended attribute tar: Ignoring malformed pax extended attribute tar: Error exit delayed from previous errors. When I download directly https://doxygen.nl/files/doxygen-1.9.7.src.tar.gz I also get those error when I try to tar xzf the package. Could you fix it ? Because now nobody can install PHP 8.1 anymore with brew :( Thanks |
From: Koenig H. (BST/EOS2) <Harald.Koenig2@Bosch-Sensortec.com> - 2023-05-15 23:41:56
|
Hi Doxygen community! I'd like to see file/lib/git version info in the LaTeX output of doxygen for our C library code. I've added a small filter script providing the info string FILE_VERSION_FILTER = ../../tools/file_version_for_doxygen.sh and I can see that info in doxygen console output Version of .../include/bml_api.h : lib-bml-api 4.2.4 0f773c47a and TeX files doc/latex/bml__api_8h.tex:\label{bml__api_8h}\index{bml\_api.h(l ib-\/bml-\/api 4.2.4 0f773c47a)@{bml\_api.h(lib-\/bml-\/api 4.2.4 0f773c47a)}} doc/latex/refman.idx:\indexentry{bml\_api.h(lib-\/bml-\/api 4.2.4 0f773c47a)@{bml\_api.h(lib-\/bml-\/api 4.2.4 0f773c47a)}|hyperpage}{3} but I cannot find my "version info" in the PDF anywhere: $ pdftotext refman.pdf $ grep 0f773c47a refman.txt $ I've tried both doxygen versions 1.9.1 (Ubuntu 20.04 LTS) and 1.8.19 (don't ask:), both showing the same symptoms... what am i missing? thanks for your help! Harald -- Mit freundlichen Grüßen / Best regards Harald König BST/EOS2Bosch Sensortec GmbH | Gerhard-Kindler-Straße 9 | 72770 Reutlingen | GermanyTel +49(7121)35-38606 | Fax +49(7121)35- 35909www.bosch-sensortec.com | Harald.Koenig2@Bosch-Sensortec.com Sitz: Kusterdingen, Registergericht: Stuttgart HRB 382674,Ust.IdNr. DE 183276693 - Steuer-Nr. 99012/08040Geschäftsführung: Stefan Finkbeiner, Harald Kröger |
From: BIMANATULA S. <som...@gm...> - 2023-05-12 13:25:48
|
Hello Team, Greetings for the day !!! While I generate a Doxygen XML Documentation, I always get the line number and absolute path of the file in the Documentation. Is there a way I can remove this line number and absolute path? *Below is for reference:-* Definition at line 84 of file ..........................................................*.h Thanking You, With Regards, Somanath.B. |
From: Rob M. <rob...@gm...> - 2023-05-01 21:27:26
|
Has anyone used Doxygen to generate documentation for input and /or output file formats? I'm working in the paradigm of a command line program that has a few plain-text files as input -- and a bunch of other plain-text files as output. I'm looking for a means of annotating file read statements (fscanf, fread, whatever) in the source code. Then, upon running Doxygen (or another tool) and providing a pointer to an example file, some form of input file documentation is generated. If anyone has used Doxygen for this kind of thing, links to a GitHub repo showing techniques and best practices would be appreciated. Thanks for any suggestions. Rob |
From: Travis E. <tra...@gm...> - 2023-04-21 18:12:27
|
I've opened a PR (https://github.com/doxygen/doxygen/pull/9992) and have updated the fix; if you try this before it's merged, you can build from https://github.com/abathur/doxygen/tree/fix_schema_version. Also, I noticed while poking at the sqlite `.read` command: it's not for loading a database--it'll throw parse errors even on a well-formed db. I think it expects the file to contain either SQL or a command that will generate SQL. On Wed, Apr 19, 2023 at 10:40 PM Travis Everett <tra...@gm...> wrote: > I have a project with some tests against the SQLite behavior. I needed to > dust it off a bit, but I was able to get it working at the major versions > between now and the last time I touched it (without seeing this issue > myself). > > I did notice some regressed behavior, mostly around some 2021 QCString > refactoring and have a commit fixing it. I'm curious if this happens to > work for you if you build from it: > https://github.com/abathur/doxygen/commit/6106b5119ba84a692dd7cdf1e91535cbd83ec070 > > > The line you're quoting for the parse error looks like data for the "meta" > table. Here's an example of what that looks like in a db from one of my > tests: > > sqlite> select * from meta; > doxygen_version = 1.9.7 > schema_version = 0.2.1 > generated_at = Wed Jan 2 1980 00:00:00 > generated_on = Wed Jan 2 1980 > project_name = ManualTest > project_number = 1.1.22 > project_brief = A quick idea about the purpose of the project > > and the statement binding the value for `schema_version` is one of the > ones I fixed. > > On Tue, Apr 18, 2023 at 12:30 PM Chad Cornwell <cor...@gm...> > wrote: > >> I compiled from source on centos 7 using the scl dev toolset 7 (if this >> matters) for doxygen 1.9.7 with the -Duse_sqlite3 flag on. >> >> I was able to successfully run doxygen on my code directory and did not >> see any error flags pop up relating to sqlite3 (or any at all) however when >> I try to open up the database using sqlite3 it responds to .tables with ' >> Errror: file is not a database' >> >> Additionally when I try to .read doxygen_sqlite3.db it gives the >> following error: >> Parse error near line 1: unrecognized token "18a592b71f" >> 18a592b71fc2*)0.2.1TueApr 18 2023 17:54:53Tue Apr 18 2023My Project >> 05acdd2d7 >> ^--- error here >> >> It seems as if the data is populated into the .db file but it is getting >> corrupted somehow along the way, any ideas on how to fix this? Thank you so >> much for your help! >> _______________________________________________ >> Doxygen-users mailing list >> Dox...@li... >> https://lists.sourceforge.net/lists/listinfo/doxygen-users >> > |
From: Travis E. <tra...@gm...> - 2023-04-20 03:40:53
|
I have a project with some tests against the SQLite behavior. I needed to dust it off a bit, but I was able to get it working at the major versions between now and the last time I touched it (without seeing this issue myself). I did notice some regressed behavior, mostly around some 2021 QCString refactoring and have a commit fixing it. I'm curious if this happens to work for you if you build from it: https://github.com/abathur/doxygen/commit/6106b5119ba84a692dd7cdf1e91535cbd83ec070 The line you're quoting for the parse error looks like data for the "meta" table. Here's an example of what that looks like in a db from one of my tests: sqlite> select * from meta; doxygen_version = 1.9.7 schema_version = 0.2.1 generated_at = Wed Jan 2 1980 00:00:00 generated_on = Wed Jan 2 1980 project_name = ManualTest project_number = 1.1.22 project_brief = A quick idea about the purpose of the project and the statement binding the value for `schema_version` is one of the ones I fixed. On Tue, Apr 18, 2023 at 12:30 PM Chad Cornwell <cor...@gm...> wrote: > I compiled from source on centos 7 using the scl dev toolset 7 (if this > matters) for doxygen 1.9.7 with the -Duse_sqlite3 flag on. > > I was able to successfully run doxygen on my code directory and did not > see any error flags pop up relating to sqlite3 (or any at all) however when > I try to open up the database using sqlite3 it responds to .tables with ' > Errror: file is not a database' > > Additionally when I try to .read doxygen_sqlite3.db it gives the following > error: > Parse error near line 1: unrecognized token "18a592b71f" > 18a592b71fc2*)0.2.1TueApr 18 2023 17:54:53Tue Apr 18 2023My Project > 05acdd2d7 > ^--- error here > > It seems as if the data is populated into the .db file but it is getting > corrupted somehow along the way, any ideas on how to fix this? Thank you so > much for your help! > _______________________________________________ > Doxygen-users mailing list > Dox...@li... > https://lists.sourceforge.net/lists/listinfo/doxygen-users > |
From: Chad C. <cor...@gm...> - 2023-04-18 17:29:47
|
I compiled from source on centos 7 using the scl dev toolset 7 (if this matters) for doxygen 1.9.7 with the -Duse_sqlite3 flag on. I was able to successfully run doxygen on my code directory and did not see any error flags pop up relating to sqlite3 (or any at all) however when I try to open up the database using sqlite3 it responds to .tables with ' Errror: file is not a database' Additionally when I try to .read doxygen_sqlite3.db it gives the following error: Parse error near line 1: unrecognized token "18a592b71f" 18a592b71fc2*)0.2.1TueApr 18 2023 17:54:53Tue Apr 18 2023My Project 05acdd2d7 ^--- error here It seems as if the data is populated into the .db file but it is getting corrupted somehow along the way, any ideas on how to fix this? Thank you so much for your help! |
From: Robert H. <he...@de...> - 2023-04-17 20:09:59
|
At Mon, 17 Apr 2023 22:00:21 +0200 Ren?_Staffen <r.s...@gm...> wrote: > > void is not a return type. > And even if void would be a type - there is no sense in just copy the > type onto the \return doc. > \return should document the semantic and not the syntax. The syntax is > allready documented by the code. > So no return type (void function) -> no return semantic to document -> > no \return command > The same is true for parameter. Right. One *can* say something like: "@returns nothing" for a function declared as returning void. One can say other things like "This function is for a [side] effect." There are various ways of expressing this. And yes, one should duplicate types in either the @param or @return commands, since Doxygen is already getting the typenames from the code itself and will document that in the function's prototype in the heading. > > > Am 17.04.2023 um 21:17 schrieb Pratyush Jayachandran: > > I'm documenting a project written in C. > > > > I couldn't find the rules for documenting functions that return void > > and/or have no parameters. > > > > By extension of other rules, should it be > > @return void > > and > > @param void > > > > Omitting them will result in the document showing just blank. > > > > Is it left on the user to decide? What is the industry standard? > > > > Regards, > > Pratyush > > > > > > > > _______________________________________________ > > Doxygen-users mailing list > > Dox...@li... > > https://lists.sourceforge.net/lists/listinfo/doxygen-users > > > > _______________________________________________ > Doxygen-users mailing list > Dox...@li... > https://lists.sourceforge.net/lists/listinfo/doxygen-users > > > -- Robert Heller -- Cell: 413-658-7953 GV: 978-633-5364 Deepwoods Software -- Custom Software Services http://www.deepsoft.com/ -- Linux Administration Services he...@de... -- Webhosting Services |
From: Robert H. <he...@de...> - 2023-04-17 20:07:01
|
At Mon, 17 Apr 2023 12:17:32 -0700 Pratyush Jayachandran <pra...@gm...> wrote: > > I'm documenting a project written in C. > > I couldn't find the rules for documenting functions that return void and/or > have no parameters. > > By extension of other rules, should it be > @return void > and > @param void > *I* usually just leave the @param out if there are no parameters. For @return for a void function, I would say "@returns nothing" Typically something like this: /** This is a function returning void. * @param a First param * @param b Second param * @returns nothing. */ void foo(int a, int b); /** This is a function with no parameters. * @return The uptime. */ long long int uptime(); /** This is a functions with no parameters returning void. * @returns nothing. */ void nothing(); > Omitting them will result in the document showing just blank. > > Is it left on the user to decide? What is the industry standard? Different people have different "standards" for documentation. > > Regards, > Pratyush > > _______________________________________________ > Doxygen-users mailing list > Dox...@li... > https://lists.sourceforge.net/lists/listinfo/doxygen-users > > -- Robert Heller -- Cell: 413-658-7953 GV: 978-633-5364 Deepwoods Software -- Custom Software Services http://www.deepsoft.com/ -- Linux Administration Services he...@de... -- Webhosting Services |
From: René S. <r.s...@gm...> - 2023-04-17 20:00:35
|
void is not a return type. And even if void would be a type - there is no sense in just copy the type onto the \return doc. \return should document the semantic and not the syntax. The syntax is allready documented by the code. So no return type (void function) -> no return semantic to document -> no \return command The same is true for parameter. Am 17.04.2023 um 21:17 schrieb Pratyush Jayachandran: > I'm documenting a project written in C. > > I couldn't find the rules for documenting functions that return void > and/or have no parameters. > > By extension of other rules, should it be > @return void > and > @param void > > Omitting them will result in the document showing just blank. > > Is it left on the user to decide? What is the industry standard? > > Regards, > Pratyush > > > > _______________________________________________ > Doxygen-users mailing list > Dox...@li... > https://lists.sourceforge.net/lists/listinfo/doxygen-users |
From: Pratyush J. <pra...@gm...> - 2023-04-17 19:17:51
|
I'm documenting a project written in C. I couldn't find the rules for documenting functions that return void and/or have no parameters. By extension of other rules, should it be @return void and @param void Omitting them will result in the document showing just blank. Is it left on the user to decide? What is the industry standard? Regards, Pratyush |
From: James J. <jej...@gm...> - 2023-03-21 13:33:57
|
If one's configuration file includes CALLER_GRAPH = YES does doxygen generate caller graphs for library functions? If it does, is there a way to keep that from happening while still allowing caller graphs for other functions? |
From: Robert H. <he...@de...> - 2023-03-01 16:21:15
|
At Wed, 1 Mar 2023 10:38:13 -0500 Steven Martin <sma...@gm...> wrote: > > Hello, > > Is it possible to include the source code listing in doxygen generated HTML? Yes. See SOURCE_BROWSER and INLINE_SOURCES options in the Doxyfile. > > Steve > > _______________________________________________ > Doxygen-users mailing list > Dox...@li... > https://lists.sourceforge.net/lists/listinfo/doxygen-users > > -- Robert Heller -- Cell: 413-658-7953 GV: 978-633-5364 Deepwoods Software -- Custom Software Services http://www.deepsoft.com/ -- Linux Administration Services he...@de... -- Webhosting Services |
From: Steven M. <sma...@gm...> - 2023-03-01 15:45:10
|
Hello, Is it possible to include the source code listing in doxygen generated HTML? Steve |
From: Jens K. <pau...@gm...> - 2023-02-25 17:30:57
|
Hello, Each Time, I post a List Article there, I become a failure E-Mail back from a local server that is not in my Network Range. But the entire Post will be published. Maybe a diss-configured MailServer ? Jens -- Diese E-Mail wurde von Avast-Antivirussoftware auf Viren geprüft. www.avast.com |
From: Jens K. <pau...@gm...> - 2023-02-25 14:59:43
|
Hello, what are ABBREVIATE_BRIEF 's ? how can I use it ? Jens -- Diese E-Mail wurde von Avast-Antivirussoftware auf Viren geprüft. www.avast.com |