Thoroughly Document usage of the API

[GoogleCodeExporter]

Document the api via whatever is your favorite documentation system.  I 
typically use the GTK+ or QT documentation as something to compare against when 
choosing which library to utilize.  If it is not documented or poorly 
documented, it makes it much more difficult for the end user to use it, which 
will lead to poor acceptance, or lots of users bugging the developer for 
assistance and or clarification.

More practical concrete examples are strongly encouraged like your "monster" 
yamland >> operator overload technique which is fantastic)

What version of the product are you using? On what operating system?
yaml-cpp-0.3.0

Please provide any additional information below.
I'm having difficulty trying to figure out how to parse a multidimensional 
array (nested sequences).  API docs and more thorough examples would probably 
help.

Original issue reported on code.google.com by dandruc...@gmail.com on 13 Mar 2012 at 3:02

[theNerd247]

I've been using Doxygen to automagically generate some crude documentation for this project. While the code isn't well commented it's better than nothing. Shall I create a pull request with the doxygen file so other developers can use it? I can try and write some cmake stuffs to generate the documentation when installing the library.

[Qix-]

@theNerd247 generation would probably be better, so future modifications to the library can be easily documented. Doxygen is just fine; the generation process is definitely more valuable.

[theNerd247]

I'm assuming by "generation" you mean the HTML files should be added to the repo? Wouldn't it be better to just add the doxygen file to the repo and have cmake do the rest? Could you clarify what you mean please?

On November 26, 2015, at 10:52 AM, Josh Junon notifications@github.com wrote:

@theNerd247 generation would probably be better, so future modifications to the library can be easily documented. Doxygen is just fine; the generation process is definitely more valuable.

—
Reply to this email directly or view it on GitHub.

[Qix-]

I mean add the doxygen file, yes. That means people can generate the documentation themselves.

[theNerd247]

OK. That's what I was originally intending.

On November 26, 2015, at 11:44 AM, Josh Junon notifications@github.com wrote:

I mean add the doxygen file, yes. That means people can generate the documentation themselves.

—
Reply to this email directly or view it on GitHub.