Ecosyste.ms: OpenCollective
An open API service for software projects hosted on Open Collective.
github.com/breathe-doc/breathe
ReStructuredText and Sphinx bridge to Doxygen
https://github.com/breathe-doc/breathe
9ccc4a671d80bbe7139ef8b99c637925e24d022c authored over 13 years ago
159e9cd274bbfbf79e0f81519b1e6e853c88ba9f authored over 13 years ago
0f10c968b603d5eea7bd97c4d3e6126d5b8428dd authored over 13 years ago
We introduce the TemplateParamListRenderer which handles iterating over
its parameters and forma...
Make one function have only one template parameter (as seems to be the
original intention) and r...
We also add "public" statements at the top of the class which is
presumably the original intenti...
It was getting silly, this helps trim it a bit.
b0c162aea381993f3b6a69e70a57d3d18387007f authored over 13 years agoExample code for templated classes and functions
62c7d5f88a001df75f9ba1b655e3636257dc5459 authored over 13 years ago7e722a21c0db8cd77e624b20cdf88c8c70a5d72f authored over 13 years ago
fce890995cd8aae25995bd24970f3134cead8605 authored over 13 years ago
The more targetted directives were entering into the rendering hierarchy
at the MemberDefTypeSub...
d4c6d4c583844404e49a014c2f7158c1c98ced64 authored over 13 years ago
7a92f3bf3f23d41e140a98ff3589b15cfeed968b authored over 13 years ago
We improve the group name logic so that it outputs an "Unnamed Group"
title for any unnamed grou...
As it is referenced from elsewhere and so confuses some of the sphinx
setup.
``.. doxygenclass:: :members:`` now displays members in
user-defined groups (which might contain...
During a previous change we lost support for this.
We no longer need to use an emphasis node as...
0f09f25601b2fb204fd2c94ca2716b4ffa440b08 authored over 13 years ago
Perhaps I should be keeping it up to date, but similar information is
available and better place...
That's how it is meant to be referred to apparently.
54468717a598d2211ed5ff5b6a99d18d24239a6d authored over 13 years ago
Previously, we were reparsing the xml files everytime we came across
one. So this would happen t...
I realise it probably isn't great to develop with the latest and
greatest but best to be honest ...
We use this method to reflect what the users will see in the final
output without having a large...
Oops.
4cb09b7e326e65c00ac4752a8dd933f3d6f4188d authored over 13 years ago5d48df432ef60f7693d27f6d8d749c400c430930 authored over 13 years ago
There was already a VariableMemberDefTypeSubRenderer, but there was no
top-level directive for g...
The introduction of the domain references lead to a lot of duplicate ids
in the testsuite which ...
Ignoring "E501 line too long" and the final "W391 blank line at end of
file".
Mostly whitespace...
1384f875dafb2f600e7114c14e38733d6c2adc78 authored over 13 years ago
A chunk of the work was unfortunatel mixed in with the last commit. The
main parts are that we i...
When attempting to add support for Sphinx domain references to classes
it become apparent that t...
To cover the excellent work done by mbolivar.
c265d9fc83886c2835a7fceff5cba41fbbd9e765 authored over 13 years ago473134582f801f909fb5a51fc01ae51b6d144a8d authored over 13 years ago
8a941f841ae92a689768359d0666f065e7243aea authored over 13 years ago
Again, this is an issue with cross over into xml files for namespaces
including namespaces which...
Previously, if we were rendering a file with a namespace in it we would
cross over to the namesp...
Added the output for the file with nested namespaces
ae5f168301cf3800a89e97bf60ee0c2090c152fa authored almost 14 years ago
We're essentially sweeping these errors under the rug at the moment.
There is no effort in Breat...
Previously, we have had issues with the fact that classes and namespaces
are always listed as to...
To cover the multifile example
c0afff088d1cb2512a216ccd92a83797dc1c1867 authored almost 14 years agoa51279ae2457310e72646569698af44752e32572 authored almost 14 years ago
Allows us to test that the doxygenfile directive is handling it
properly.
Previously, if you used the doxygenfile directive with a filename and
there were two files match...
08805442fd1bec048b3a0c728c81af4984bebe2a authored almost 14 years ago
76c086f5838f55dcca652a3b0d3f4488d87d10c1 authored almost 14 years ago
In response to issue #27.
We split out the namespace from the name argument for the appropriate...
d70cc3016e3f691ef791b9f8310cf133b84030c6 authored almost 14 years ago
We define the doxygenfile directive class and the RefTypeSubRenderer
which is required to jump f...
This was lost in my refactor of Queezy's work. We add some examples to
the docs to illustrate th...
This means doxygenindex and doxygenfunction at this point. And not
brilliantly well tested but w...
Needed for the documentation of the outline feature. This change hasn't
been widely tested, it s...
The original code generation run also wrote out a large amount of code
for exporting the xml bac...
Motivated by the "isinstance considered harmful" line of thought, we
remove all checks based on ...
Many thanks.
91e02b9fa8c6eea523e8a084f12d84e267d358d8 authored almost 14 years ago
This is to re-implement the much needed and much appreciated
functionality in another way. Mainl...
A portion of the file was indented with tabs which contrasts with the
rest of the code base.
Th...
5c801d9e88e816617abadcef0bfdbb1d0fa9a0bc authored almost 14 years ago
<para> node content needs to be rendered in a paragraph to preserve line
breaks from the origina...
- Added rendering filter to Renderer's
Every time a renderer tries to render somthing it passe...
sections are render as rst field lists. This emulates the output
style of python function docume...
Tweaked the example code to provide better examples of raw markup and
with aliases.
Required updating the homepage In a Nutshell example, adding a
description of options to the dir...
The previous instructions were simple but poorly phrased and can be
simplified and so should.
Should keep the same behaviour it is just a better separation of
concerns. Previously the compou...
This is a closer match to the behaviour of the Sphinx autoclass
:members: option. If you specify...
These should have been two separate commits. It is a shame they are
mixed together.
The :no-lin...
dc7ec13f337a2dfbfe0270059536ebb197023ba5 authored about 14 years agoIt is pointless. Adds an extra level of indirection with no clear gain.
3f7d15b880be2659e00533a5ef220d9b3e3b367b authored about 14 years ago453c43f0471f27122047105b02852eb50eea29ad authored about 14 years ago
Changed to "haiku" Sphinx theme.
Added features section to front page.
Added credits page.
Ad...
e8dfa0ad6f6634a358e5ce645714c0a77e39f96d authored about 14 years ago
Gives the standard Sphinx literal block with preformatted text between.
Seems like the most reas...
The previous attempt to use \xmlonly doxygen markup for rst code meant
that you have to do xml-e...
Breathe was previously ignoring documentation for parameters that
appeared like this:
const ch...
b5187fc944e84b3865be8966b2c7aace86e1c729 authored about 14 years ago
The fancy attempts to calculate a better place were not working well and
added much confusion. T...
Using a couple of Doxygen aliases:
ALIASES = "rst=\xmlonly<rst>"
ALIASES += "endrst=</rst>\en...
Only implemented for doxygenindex but it is a start.
34dada649ad62ec68fa670e6be539b968daff263 authored about 14 years ago
First, lengthy, pass at adding domain support to breathe, so that when
it outputs functions, it ...
Long since replaced by the Finder classes.
84cdf7ddb5f76d5ccddc653ea45a1e23203217e4 authored about 14 years ago
The \par doxygen markup allows users to specify there own paragraph with
an optional title. It c...
Requires example code in nutshell.h, both for generating the xml and for
including in the docume...
e5f6a6e9980cb1875a9e30e4f907c46a2e47d8d3 authored about 14 years ago
d57099391807bffe46fb3aaff229706d73e911dc authored about 14 years ago
Needs more work but is a promising start.
Contains code guide for the doxygen xml output and pa...
2bbdc522cd725d20a9e06ec49beeb49db17cec90 authored over 14 years ago
It seems that the target node is not actually what we're linking to in
this case and that the im...
The API for pendin_xrefs seems to have changed for Sphinx v1.0. Now the
xref code we're trying t...
This is necessary so that separate paragraphs in the descriptions are
rendered as separate parag...
Previously our dictionary for translating names from the xml to something
more readable was inco...
Previous efforts to improve function pointer typedef displays neglected
variables which are func...
Requires splitting on the final "::" in the name and matching the first
part to the compound nam...
In response to issue #10.
Request to "Values" title in case the enum values appear like they ar...
2cf443c61e42886532792a39a60544eace2c44d8 authored over 14 years ago
It was noticed that text marked-up with doxygen tags like \a were not
being rendered at all. Thi...
Previously, given a detailed description the "Parameters" title would
appear on the end of the d...
It now displays the value of any enum entries in literal format next to
the value name.
Doxygen...
ddc7c128443aadfbb629cc2576a8731c1cb12f4e authored over 14 years agoLeaving further work until the parsing is refactored.
Ideally, I'd rather see:
typedef void (...
148091d3e154b9bdcd76e0c849f1aa311caf7f46 authored over 14 years agod555c0bb54190c7fedbecdf02a742fa60ebbce87 authored over 14 years ago
939e114dd5bc006dc4557adac772f65e7ff20a65 authored over 14 years ago
d49d79aa6b5368b6229d202a8c2e0495407dab99 authored over 14 years ago
b235eeb96b09ed7493b34c9ebcaaa7ad43b43ac6 authored over 14 years ago
New folder with mini makefile copying the doxygen example structure.
Added rst file referencing...
2260e34449e48bb4687d21c50222ef625c215907 authored over 14 years ago
Improved on the previous basic "overload render()" concept. Now "render" is
always called on the...
Functions, typedefs, enums and probably others all come up as "memberdef"
nodes so we're choosin...
Was previously ignoring the enum sections completely. Could still be improved.
In particular the...
ca225d2d8265d00ba6d4e1badc7d589836b64db6 authored over 14 years ago
Previously we were only picking up direct text in the <ref></ref> scope.
This involves extendin...
d735400528dfb6374f6b4e1947a1fc24b4d84e42 authored over 14 years ago3f874bdc109307d0cbea30d283c8e0f930c446e7 authored over 14 years ago