Add API.md documenting all available methods

mapbox / variant

C++11/C++14 Variant

BSD 3-Clause "New" or "Revised" License

371 stars 101 forks source link

Open anandthakker opened 7 years ago

anandthakker commented 7 years ago

it'll be better to have a separate page listing all available methods while README only mentions basic building blocks

lucaswoj commented 6 years ago

Just had a quick phone call with @mapsam and @anandthakker to discuss this. We're going to band together to write a lightweight API.md that

lists all methods
provides a 1-2 sentence summary of each (can draw upon http://en.cppreference.com/w/cpp/utility/variant in many cases)
provides an inline example of each
links to available open source documentation for each