Tommaso Pecorella
1eac22c4b0
documentation: Doxygen post fixes
2022-01-31 22:19:11 +00:00
Tommaso Pecorella
c9ae2bfc84
utils: doxygen fixes
2022-01-30 12:06:53 -06:00
Tommaso Pecorella
8ac0116193
core: doxygen fixes
2022-01-30 12:06:53 -06:00
Tommaso Pecorella
a8fc1b6235
doxygen: fix warnings in various modules
2022-01-05 00:22:31 -06:00
Peter Barnes
7f3d883f75
core: fix doxy warnings
2021-12-21 17:06:57 +00:00
Stefano Avallone
6ec6fc2eb6
core: Add an attribute value storing a std::tuple
2021-12-06 10:49:40 +01:00
Mathew Bielejeski
2cea1e4ccd
core: (merges !434 ) Length class to support length values with units
2020-12-02 20:05:29 -08:00
Jared Dulmage
d244597a2b
Documentation, better conformance to AttributeChecker conventions
...
Both PairChecker and AttributeContainerChecker factory functions
modified to return more generic AttributeCheckers similar to other
attribute types. By removing the templated return type, the internal
templated classes become necessary to define checkers for each
templated type. This follows the pattern in PointerChecker and
ObjectContainerChecker.
The pair-value-test-suite and attribute-container-test-suite were
amended to account for the changes in the checker factories. All
tests continue to pass.
Plenty of documentation was added to PairValue and AttributeContainerValue
and I also removed some dead code.
2020-09-20 15:33:38 -07:00
Jared Dulmage
c8f2bf250e
Addressed comments for nsnam/ns-3-dev MR 91
...
- Removed unnecessary files src/core/model/{attribute-container,pair}.cc
- Removed 'explicit' modifier to PairChecker
- Modified output stream operator for PairValue; update PairValueTestCase
- Updated src/core/wscript to latest master
- Added Pair and AttributeContainer to utils/print-introspected-doxygen.cc
2020-09-20 14:52:02 -07:00
Peter D. Barnes, Jr
b23be18b3b
Use CommandLine cmd (__FILE__) instead of COMMANDLINE macro.
...
This in effect replaces commit 5e624d550
2020-05-01 14:42:53 -07:00
Peter D. Barnes, Jr
5e624d5504
doc: Use the new COMMANDLINE macro in every example
2020-04-27 16:20:09 -07:00
Peter D. Barnes, Jr
da6e6b340f
docs: various fixes for broken links, removed AttributeValue types
2020-04-27 16:20:09 -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
2fb2ed1689
doc: use \pname{} instead of \p when referring to arguments.
2020-04-10 17:30:25 -07:00
Parth Pandya
741fd9feee
doc: Add to doxygen a list of all TypeIds
2020-02-03 15:50:48 -08:00
Peter D. Barnes, Jr
60680946bb
docs: Refactor print-introspected-doxygen
2020-02-03 15:43:09 -08:00
Sébastien Deronne
cb43ae1607
wifi: Clear doxygen warnings
2018-02-10 16:34:54 +01:00
Sébastien Deronne
27ac6c1c3c
wifi: cleanup remaining Doxygen warnings
2017-10-21 10:12:18 +02:00
Peter D. Barnes, Jr.
c923be0a32
Minor fixups
2017-09-17 19:47:23 -07:00
Peter D. Barnes, Jr.
485c2673b8
[doxy] Add doxygen file header to introspected-doxygen.h
2017-08-29 07:56:38 -07:00
Tom Henderson
b68a27364c
wifi: Extend documentation helper for attribute implementations
2017-08-29 14:51:27 -07:00
Tom Henderson
0b0bfedf27
utils: clear a doxygen warning
2017-03-19 07:51:54 -07:00
Tom Henderson
1d270b3a74
utils: Improve some documentation
2017-02-24 11:49:00 -08:00
Robert Ammon
f25f9dc730
utils: Doxygen updates for utils directory
2017-02-24 09:23:49 -08:00
Tom Henderson
924dddd824
remove duplicate entry
2015-12-09 19:31:49 -08:00
Tommaso Pecorella
3a8d1a1bda
some small fixes
2015-11-11 21:52:39 -08:00
Peter D. Barnes, Jr.
9e71fc449f
[Doxygen] Template parameter deduction.
2015-07-22 17:09:55 -07:00
Peter D. Barnes, Jr.
576769caf1
bug 2043: print-introspected-doxygen crashes when some modules are disabled
2015-01-29 19:03:22 -08:00
Peter D. Barnes, Jr.
5b9e3507b7
[Bug 2022] Spurious characters in config paths
...
On Nov 24, 2014, at 12:48 PM, Tom Henderson <tomh@tomh.org > wrote:
> On 11/24/2014 12:39 PM, Peter Barnes wrote:
>> I see the '%' being use in two places, beginning at line 1156 in
>> StaticInformation::DoGather ()
>>
>> Mitch used the % to escape the class names so doxygen wouldn't
>> create links. I'm not sure why the links are bad. Is the config
>> path token with '::' sometimes not the same as a class name?
>> Then doxygen would be looking for a non-existent class and
>> complaining, so suppressing might be good.
>>
>> Looks like I might have added the surrounding '"' in r10977.
>> Could this be the problem?
>
> Not sure. Let me know if you don't get to this before you
> disappear for a while, and I'll pick it up if so.
Removing the quotes fixes the problem.
Removing the '%' (and leaving the quotes) fixes the problem.
This is my preferred solution, since it's a reminder that
the config path is just a string.
So my recommendation is to remove the temporaryCharacter
formatting string completely.
2014-12-03 15:27:46 -08:00
Tom Henderson
d6edb8dcbd
record Doxygen aggregation info for additional classes
2014-11-20 13:42:09 -08:00
Peter D. Barnes, Jr.
1e1a1edbdc
[Doxygen] various in src/core
2014-11-03 12:40:24 -08:00
Peter D. Barnes, Jr.
cccfc167dd
[Doxygen] Attribute implementations.
2014-10-21 16:14:35 -07:00
Tommaso Pecorella
b703ac7f27
Fix missing header
2014-10-09 12:40:49 +02:00
Peter D. Barnes, Jr.
792c339edc
[Doxygen] Include the size of registered types in the long description for the class.
2014-10-08 13:52:14 -07:00
Peter D. Barnes, Jr.
9346f805f2
Generate doxygen list of all LogComponents
2014-10-06 17:24:00 -07:00
Peter D. Barnes, Jr.
6313928fbc
[doxygen] print-introspected-doxygen.cc
2014-10-05 20:42:52 -07:00
Peter D. Barnes, Jr.
a4d68196e7
Refactor print-introspected-doxygen.cc
2014-10-05 17:58:48 -07:00
Peter D. Barnes, Jr.
24144c56f9
Implementation for documenting TracedValue and TracedCallback signatures.
2014-10-02 21:05:15 -07:00
Peter D. Barnes, Jr.
a274c8ea37
[doxygen] Make introspected lists more visible, various other doxy
2014-03-10 10:57:50 -07:00
Vedran Miletić
b5891dce41
Replace <limits.h> include by <climits>
2013-07-06 16:55:33 +02:00
Vedran Miletić
b47d4aac23
Add missing limits.h include to nstime.h and print-introspected-doxygen.cc
2013-07-04 15:57:10 +02:00
Peter D. Barnes, Jr.
c55d9ac5a9
Show defaults for global values.
2013-06-11 17:41:37 -07:00
Mitch Watrous
1bf68e5219
Bug 1520 - config paths not documented in Doxygen for CsmaChannel
2013-01-18 13:03:18 -08:00
Tom Henderson
683af560b1
workaround for bug 1561: doxygen for optional modules
2012-12-21 15:50:25 -08:00
Mitch Watrous
05ddd7089b
Bug 1520 (More partially) - config paths not documented
2012-12-07 10:12:40 -08:00
Mitch Watrous
3d24d6b4c0
Bug 152 (Partially)- config paths not documented
2012-12-05 17:06:27 -08:00
Peter D. Barnes, Jr.
2851f35a05
Fix oxygen errors in doc/introspected-doxygen.h
2012-11-09 17:57:28 -08:00
Peter D. Barnes, Jr.
ebde3d2bf5
Doxygenate print-introspected-doxygen.cc
2012-11-07 15:32:36 -08:00
Peter D. Barnes, Jr.
794336acbb
Highlight attribute flags in doxygen html
2012-11-07 13:32:15 -08:00
Peter D. Barnes, Jr.
e969f87645
Move attribute, config, trace docs to class description.
2012-08-13 16:56:18 -07:00