search

kastnermario / yaml-cpp

Automatically exported from code.google.com/p/yaml-cpp
MIT License
0 stars 0 forks source link

Thoroughly Document usage of the API #155

Closed GoogleCodeExporter closed 8 years ago

GoogleCodeExporter commented 8 years ago 
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

GoogleCodeExporter commented 8 years ago 
You're right, it should be better documented. It's an ongoing struggle :)

For your particular question, please ask it on stackoverflow.com and I (or 
someone else) will answer it.

Original comment by jbe...@gmail.com on 15 Mar 2012 at 3:22

GoogleCodeExporter commented 8 years ago

Original comment by jbe...@gmail.com on 19 May 2012 at 9:09

GoogleCodeExporter commented 8 years ago 
This issue has moved to github: https://github.com/jbeder/yaml-cpp/issues/155

Original comment by jbe...@gmail.com on 30 Mar 2015 at 1:29