Hi! I'm using Breathe[1] with Sphinx to include Doxygen-parsed documentation in Sphinx. It generally works well, with the major exception of anonymous types and fields. For example, this bit of perfectly legal (and perfectly ordinary) C:
struct mystruct {
enum { A, B, C} field1;
union {
int field2_int;
float field2_float
};
}
Confuses Sphinx to no end, because Sphinx wants everything to have a
name, and both fields have anonymous (local) types, and the second field
(the union) doesn't even have a name!. A similar example with rendered
Sphinx output can be found on the issue I reported on Breathe:
<https://github.com/michaeljones/breathe/issues/369>. Notice how the C
code, even without documentation, is *much* more readable than the
documentation itself!
Doxygen on the other hand has very good understanding of this kind of
constructs and generates perfectly readable documentation, so the issue
*really* lies somewhere in Sphinx and/or Breathe.
Is there a way to improve Sphinx-generated documentation for this kind
of constructs?
Thanks!
[1]: https://github.com/michaeljones/breathe
--
Thibault
--
You received this message because you are subscribed to the Google Groups
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.
signature.asc
Description: PGP signature
