search

davfuenmayor / ruby-doxygen-parser

Ruby library that uses Doxygen XML output to parse and query C++ header files
MIT License
4 stars 2 forks source link

How to retrieve documentation #1

Open kugel- opened 8 years ago

kugel- commented 8 years ago

Hello, first of all: thanks for your wonderful library!

I found it difficult to get the documentation for functions etc., which is weird since doxygen is about code documentation.

Fundamentally I'm trying to process functions and types that have documentation at all (I know doxygen xml tends to include all functions, including undocumentated ones such as local (static) helper functions).

davfuenmayor commented 8 years ago

Hi Thomas, I didn't actually create the library with documentation in mind, but to extract metadata from code (classes, functions, params etc) so I am afraid you will have to modify the library. What you want to do should not be difficult, just need to use Nokogiri to parse the intermediate XML file generated by Doxygen. Best regards!

On Wed, Jul 29, 2015 at 10:33 AM, Thomas Martitz notifications@github.com wrote:

Hello, first of all: thanks for your wonderful library!

I found it difficult to get the documentation for functions etc., which is weird since doxygen is about code documentation.

Fundamentally I'm trying to process functions and types that have documentation at all (I know doxygen xml tends to include all functions, including undocumentated ones such as local (static) helper functions).

— Reply to this email directly or view it on GitHub https://github.com/davfuenmayor/ruby-doxygen-parser/issues/1.

kugel- commented 8 years ago

Yea, I figured that. However the Nokogiri data is in "raw" format making it a bit cumbersome.