TODO
Todo
Exhale is being updated in waves as I have free time. It was originally written to
be tracked by the user next to conf.py
. Keeping it in a single file made this
as convenient as possible for users, but was ultimately inconvenient to maintain.
Right now, the graph
module is largely the same as it was in the single
file library version. Eventually this will be whittled down into the other modules
present in the library (e.g., modularizing writing nodes to file, parsing of xml).
Todo
More fine-grained control will be available in the pickleable writer API sometime in Exhale 1.x.
Todo
add some pictures of the different hierarchies once this is packaged
Todo
This feature is NOT implemented yet! Hopefully soon. It definitely gets under
my skin. It’s mostly documented just to show up in the todolist
for me ;)
Todo
add documentation of this method
Todo
document this, create another method for creating this without the need for generating links, to be used in making the node titles and labels
Todo
long time from now: intersphinx should be possible here
Todo
fmt_spec docs needed. keys are kind
and values are color spec
Todo
add thorough documentation of this
Todo
many attributes currently stored do not need to be, refactor in future release
to just use the configs
module.
Todo
node discovery has changed, breathe no longer used…update docs
Todo
writing the actual file should be set in one method so that things for files, namespaces, and leaflike nodes don’t keep getting out of sync
Todo
actually document this
Todo
actually document this
Todo
cleanup / reorder these
Todo
update docs for new list version rather than string returns
Todo
document better / this gets updated in v1.0.0
Todo
This value is saved in order to be able to distinguish when a “separate
source and build” directory is being tested. At this time this is not
fully implemented, self.app.srcdir
should be a subdirectory of
self.testroot
and conf.py
/ index.rst
should be generated
there.
Currently, these are always generated in testroot
, implying that
there is no “separate source and build” directory structure. Solution
requires further investigation of the sphinx testing suite.
Todo
identify via a
file_*
method that{doxygenStripFromPath}
was correctly removed / wielded.
Todo
stop reloading configs module in 1.x.
Todo
????
values indicate items not currently implemented or used in the testing
framework.
Todo
On a day that is not this day, make ExhaleNode.template_params
use a
class Tparam
and reuse that here and in the testing framework. And
just rename it to template
, unifying with kind=function
, and have
the testing framework use the same variable name. But that’s a lot of
effort right now and I just want good debugging prints.
Todo
template specification / creation TBD for classes / structs.
Todo
enumvalues are not currently handled in Exhale proper.
Todo
template specification / creation TBD for functions.
Todo
union members are not actually tested at this point.
Todo
These tests are incomplete (from __future__ import config_objects
). The
module level storage creates conflicts between the test cases when specifying
the regular expressions :/
Currently there is only one test for a custom lexer mapping, and it only actually works because the name is alphabetically sorted after the default test (meaning pytest will run it after).
Todo
The full function validation does not support templates (yet). Templates at large in the testing framework need to be reworked, currently it is all boiler plate code with no actual validation…
Todo
Too much shared code in hierarchy comparisons, the class hierarchy for this
project should be empty. Need to enable asserting this fact (same for
the cpp_nesting
project).
Todo
Class hierarchy not tested here, need to revisit that part of the testing framework as well as stop emitting a “Class Hierarchy” on the root api page when it is empty.
Todo
add some pictures of the different hierarchies once this is packaged
Todo
In Exhale v1.0.0 (when full-fledged projects are supported) each heading on this page will receive a formal reStructuredText label to ease the process of linking to this page.
Danger
This has an important consequence for you! If you use the linking strategy described here, when formal reStructuredText labels are introduced, your links will likely break (because it changes the anchor point from the title to the generated label).