[Github-comments] [geany] doxygen: various doxygen-related fixes in preparation for gtkdoc generation (302b40e)

Matthew Brush notifications at xxxxx
Thu Dec 17 15:53:12 UTC 2015


> If they are not documented I need to find another way to get them into the gir

I'm don't know GIR/FFI all that well but from what I've used of it, I don't see why it would matter. If the members of the struct that use this type are never accessed (ie. no libffi calls ever "wrap" them ... so no need of offset/size of member), and the structure they're contained in is never used "by value" (ie. the size of the structure doesn't need to be mentioned), unless I misunderstood the concept, it should still work fine.

If that's not the case, as I mentioned in the previous PR, Doxygen has an [`@internal` command](https://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmdinternal) that you can document those members with that will cause them to be emitted when `INTERNAL_DOCS` is set to `YES`. If that doesn't work for some reason, you could probably use the `HIDE_UNDOC_MEMBERS` option for the GIR generation to cause all undocumented struct members to be included in the output. Of course for those to work, you'd have to use a separate Doxyfile for the GIR generation, unless you are able to override by command line arguments/environment variables, or had the same Doxyfile processed twice each to its own output file which controlled those options.

---
Reply to this email directly or view it on GitHub:
https://github.com/geany/geany/commit/302b40e9778ff49407902f3ef9f272ed202f4547#commitcomment-15045083
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.geany.org/pipermail/github-comments/attachments/20151217/07184286/attachment.html>


More information about the Github-comments mailing list