Re: libcurl - help needed
- Posted by _tom (admin) Oct 28, 2016
- 3352 views
I get the idea for the syntax to adopt, but something sounds bizarre:
curl_version function has curl_easy_escape documentation!
Jean-Marc
Only bizarre because I don't know exactly what you are documenting. The "easy" keyword sounded like it should be the target routine!
I created a reference tutorial on setting a standard format for creating documentation http://openeuphoria.org/wiki/view/sample.e.wc
The old way was to format using Creole markup and that was what the docs looked like.
My current thinking is to add more tags (maybe just a heading like Returns;) and use as little formatting as possible. Then, the idea is to write a utility that reads a tag and then formats text into the final docs.
For example, constants and routines appear as you write them, but a simple utility sorts them into alphabetical order. For example: an extra tag could be used to group related routines together and the docs re-arrange themselves into a new order.
We can use your curl.e for testing out new ideas.
_tom
