CA-261855: Generate automatically an image map for the API classes. #3167
Conversation
|
Several files have "100644 → 100755" (permissions changed), which is probably by accident. |
ocaml/doc/index.html
Outdated
| @@ -81,8 +56,6 @@ <h1 class="title">XenAPI Classes</h1> | |||
| <li> add_to_X: add a key/value pair (only if field has type set or map); and</li> | |||
There was a problem hiding this comment.
We should fix these two at some point, as this is true only for maps...
ocaml/doc/README.md
Outdated
| @@ -1,13 +1,14 @@ | |||
| # A note on generating locally the API reference | |||
|
|
|||
| Run `make doc`. The output is in `_build/ocaml/doc/markdown`. | |||
| Run `make doc`. The output is in `_build/ocaml/doc`. | |||
There was a problem hiding this comment.
I think this section could be made clearer.
-
Running
make doccreates documentation in HTML format in_build/ocaml/doc. This requiresgraphivto be installed for generating images from*.dotfiles -
To generate documentation in PDF format, run
sh doc-convert.shin_build/ocaml/doc. This requirespandocandpdflatexbeing installed. -
To generated documentation in Docbook format, run
sh doc-convert.sh --docookin_build/ocaml/doc. This requirespandocbeing installed.
Why not provide makefile targets for these?
make-docmake-doc-htmlmake-doc-pdfmake-doc-docbook
There was a problem hiding this comment.
I'll extend the README, but I'm not sure it's a good idea to expose these targets in the Makefile, because it gives the impression it should run out of the box, but it doesn't because pandoc and latex are not in the dependencies.
ocaml/doc/index.html
Outdated
| <li> add_to_X: add a key/value pair (only if field has type set or map); and</li> | ||
| <li> remove_from_X: remove a key (only if a field has type set or map).</li> | ||
| <li> add_to_X: add a key/value pair (only if field has type map); and</li> | ||
| <li> remove_from_X: remove a key (only if a field has type map).</li> |
There was a problem hiding this comment.
Oh, if you fix that here in this PR, then please also add add_X and remove_x for the set types... :)
Also: fixed the size of the image; moved the method return type into the same line as the rest of the method signature. Signed-off-by: Konstantina Chremmou <konstantina.chremmou@citrix.com>
Also: fixed the size of the image; moved the method return type into the same
line as the rest of the method signature.
Signed-off-by: Konstantina Chremmou konstantina.chremmou@citrix.com