Commit Graph

44 Commits

Author SHA1 Message Date
Tommaso Pecorella
6fb9855af5 doc: align documentation and classes to match and remove warnings. 2024-02-21 12:29:26 -06:00
Stefano Avallone
c2d40537e5 doc: Update doxygen blacklist filter 2023-08-20 13:57:51 +00:00
Tommaso Pecorella
f61ab9ac8c doc: always report the warnings at end of doxygen check 2022-12-20 10:41:41 +00:00
Tommaso Pecorella
8ea83b4f72 doc: report additional doxygen warnings 2022-08-30 20:30:42 +00:00
Tommaso Pecorella
5b28481d4f ci: fix wrong exit code in doxygen CI 2022-02-07 12:11:17 -06:00
Tommaso Pecorella
1eac22c4b0 documentation: Doxygen post fixes 2022-01-31 22:19:11 +00:00
Gabriel Ferreira
0888aa9f4d CI: use ns3 for the doxygen job 2022-01-27 18:27:29 -03:00
Tommaso Pecorella
efdb2e21f4 Doxygen related fixes 2022-01-08 07:08:25 +00:00
Peter D. Barnes, Jr
5398e79dc4 doxy: put warnings built docs in separate directory html-warn 2021-12-28 08:47:40 -08:00
Tommaso Pecorella
30803961f1 doc: fix doxygen warning report 2021-06-18 21:21:34 +00:00
Tommaso Pecorella
ebe65d501e doc: workaround for Mac/Linux sed differences 2021-06-16 22:47:29 +00:00
Peter D. Barnes, Jr
c9e04bf619 doc: treat empty -f or -m argument as matching nothing
Also remove extraneous '(' from blacklist RE.
2021-06-16 20:35:05 +00:00
Peter Barnes
778f604511 ci: (fixes #207) doxy use warnings report, filtered to files touched in commit 2021-05-03 02:37:51 +02:00
Peter D. Barnes, Jr
a75ca74913 Revert "doc: doc/doxygen.warnings.report.sh exit status"
This reverts commit 5164a46b9e.
2020-05-27 15:03:59 -07:00
Peter Barnes
5164a46b9e doc: doc/doxygen.warnings.report.sh exit status
This amends the script to return a tailored exit status:

With filter-in options (-m, -f) the exit status records if any warnings
were found in the listed module or files.

Without any filter-in options the exit status records whether *any*
Doxygen warnings were found.
2020-05-27 20:59:06 +00:00
Peter D. Barnes, Jr
32d820e8c7 (minor) various bits of fix-ups 2020-05-11 18:19:19 -07:00
Peter D. Barnes, Jr
fddf3eaac4 doc: various doxygen fixups in core 2020-04-10 17:30:25 -07:00
Peter D. Barnes, Jr
5096cf389d docs: refactor doxygen.warnings.report.sh to produce introspected-doxygen.h correctly. 2020-04-10 17:30:25 -07:00
Peter D. Barnes, Jr
97db4ed6eb docs: make ./waf --doxygen-no-build actually work
Make doxygen.warnings.report.sh attempt to run print-introspected-doxygen,
but not fail if p-i-d hasn't been built.
2020-03-18 17:10:36 -07:00
Peter D. Barnes, Jr.
b02adffd4a [doxy] Speed up doxygen.warnings.report.sh run 2018-01-22 17:25:15 -08:00
Peter D. Barnes, Jr.
5fe45ac83e doxy: suppress erroneous ATTRIBUTE_HELPER_HEADER/CPP warnings 2017-10-18 22:39:05 -07:00
Peter D. Barnes, Jr.
0bd2e15546 [doxy] Add blacklist of errors to ignore 2017-09-17 21:04:56 -07:00
Tom Henderson
9c6fd63995 documentation: Make script run correctly on symlinked path 2017-08-13 18:00:45 -07:00
Peter D. Barnes, Jr.
f39a77b1a5 Add filter-out option, relabel some options, for doxygen.warning.report.sh 2015-08-12 14:57:34 -07:00
Peter D. Barnes, Jr.
708bb9de05 doxygen.warnings.report.sh: add -i option to skip build, print-introspected-doxygen
Also

- Reorganize the usage message, since the options list has gotten
quite long.

- Standardize internal variables with underscores between words (very
un-ns-3 like, but really this whole thing should be in python in wscript).
2014-12-17 12:17:11 -08:00
Tom Henderson
2549938ad7 fix script problem with symbolic links 2014-12-16 12:45:04 -08:00
Peter D. Barnes, Jr.
8903ab265e Streamline progress and error reporting, show full log on errors. 2014-10-17 12:50:15 -07:00
Peter D. Barnes, Jr.
132655443b Patches to doxygen.warnings.report.sh:
Don't assume we're in a repo.
Only count unique warnings.
2014-10-03 16:01:49 -07:00
Peter D. Barnes, Jr.
b489a74147 Verbose option to doxygen.warnings.report.sh: includes doxygen build chatter. 2014-09-26 12:25:13 -07:00
Peter D. Barnes, Jr.
bfeb265434 [doxygen] Preserve modified doxygen.conf during doxygen.warnings.report.sh run 2014-03-05 16:35:00 -08:00
Peter D. Barnes, Jr.
e852bd8b8f Fix report count by module. 2013-12-11 11:57:48 -08:00
Peter D. Barnes, Jr.
2a479f198a Add options to filter by module or regular expression. 2013-12-10 08:02:07 -08:00
Peter D. Barnes, Jr.
229afd99d0 Fix bug reported by Daniel Lertpratchya <nikkipui@gmail.com>:
On Dec 6, 2013, at 8:28 AM, Daniel Lertpratchya <nikkipui@gmail.com>
 wrote:
I recently ran the doxygen.warnings.report.sh script and I got the
following error. I tried on a fresh copy of ns-3-dev and Brian
also has the same problem.

'build' finished successfully (1.649s)

Rebuilding doxygen docs with full errors...Done.
mv: missing destination file operand after ‘doc/doxygen.log’
Try 'mv --help' for more information.
No filters.

cat: doc/doxygen.warnings.log: No such file or directory
grep: doc/doxygen.warnings.log: No such file or directory
cat: doc/doxygen.warnings.log: No such file or directory

On Dec 6, 2013, at 10:36 AM, Daniel Lertpratchya <nikkipui@gmail.com>
 wrote:
I think doxygen.warnings.report.sh line 150 should be changed from
$log to $LOG. That seems to fix the problem for me.
2013-12-06 13:37:03 -08:00
Peter D. Barnes, Jr.
ca69a3255e Tweak sorting of files. 2013-12-04 15:52:48 -08:00
Peter D. Barnes, Jr.
43fb06b64c doxygen.warnings.report.sh new functionality.
You can now point to the standard log file, or specific log file.

You can also filter out test and examples.


Usage: doxygen.warnings.report.sh.mod [-eth] [-f <log-file> | -l | -s]

Run doxygen to generate all errors; report error counts
by module and file.

The default behavior is to modify doxygen.conf temporarily to
report all undocumented elements, and to reduce the run time.
The output of this special run is kept in doc/doxygen.warnings.log.
The -f or -l options use alternate log files.

-e  Filter out warnings from */examples/*
-t  Filter out warnings from */test/*

-f  Skip doxygen run; use existing <log-file>.
-s  Skip doxygen run; use existing warnings log doc/doxygen.warnings.log
-l  Skip doxygen run; use the normal doxygen log doc/doxygen.log
Only the first of -f <log-file>, -s, or -l will have effect.

-h  Print this usage message
2013-12-04 15:37:57 -08:00
Tom Henderson
0de0dbca1d improve numerical sorting, and support for analyzing existing file 2013-12-03 11:11:43 -08:00
Peter D. Barnes, Jr.
0ae8b1cb8d [Doxygen] src/core 2013-07-24 17:15:33 -07:00
Peter D. Barnes, Jr.
6b39f62563 Run introspection before doing doxygen warnings report 2013-06-11 16:43:36 -07:00
Peter D. Barnes, Jr.
6eab23c955 Show files with doxygen warnings in numerical order 2013-05-31 12:01:51 -07:00
Peter D. Barnes, Jr.
2ac8c210ba Doxygen warnings report updates
Report total number of errors, files, directories (modules).
List all files with error count.
2012-11-09 17:56:59 -08:00
Peter D. Barnes, Jr.
546e80a186 Preserve doxygen.warnings.log from last report.
Direct doxygen warnings to doxygen.log.
doxygen.warnings.report.sh moves this to doxygen.warnings.log, so
subsequent normal oxygen builds don't overwrite it.
2012-11-07 14:29:47 -08:00
Peter D. Barnes, Jr.
cdb0b82540 [Bug 1521] Use custom doxygen run to log all errors in doxygen.warnings.report.sh 2012-11-07 13:21:37 -08:00
Peter D. Barnes, Jr.
900eec4066 [Bug 1521] Have doxygen log more warnings; remove obsolete items from log report script. 2012-11-05 13:52:58 -08:00
Peter D. Barnes, Jr.
9ab593413b Script to summarize doxygen.warnings.log 2012-07-20 17:07:28 -07:00