# \#ocamldoc **URL:** https://discuss.ocaml.org/tag/ocamldoc/93.md [Latest](https://discuss.ocaml.org/latest.md) · [Categories](https://discuss.ocaml.org/categories.md) · [Tags](https://discuss.ocaml.org/tags.md) --- ## [Confusion about code structuring, dune, ocamlformat, ocamldoc (overall workflow)](https://discuss.ocaml.org/t/confusion-about-code-structuring-dune-ocamlformat-ocamldoc-overall-workflow/17726)
**Author:** [@jbe](https://discuss.ocaml.org/u/jbe)\ **Replies:** 1\ **Last updated:** [January 23, 2026, 10:47am UTC](https://discuss.ocaml.org/t/confusion-about-code-structuring-dune-ocamlformat-ocamldoc-overall-workflow/17726 "2026-01-23T10:47:01Z")
I am still (somewhat) new to OCaml and I struggle with the overall workflow of creating a project, organizing my code, documenting it, and automatically creating documentation. I would like to share my experiences here a… --- ## [Ocamldoc - how to accesss special comments when writing a custom generator?](https://discuss.ocaml.org/t/ocamldoc-how-to-accesss-special-comments-when-writing-a-custom-generator/14455)
**Author:** [@0xRamzi](https://discuss.ocaml.org/u/0xRamzi)\ **Replies:** 1\ **Last updated:** [April 11, 2024, 8:42am UTC](https://discuss.ocaml.org/t/ocamldoc-how-to-accesss-special-comments-when-writing-a-custom-generator/14455 "2024-04-11T08:42:21Z")
Hello, I’m trying to make my own ocamldoc generator, and I’m having trouble finding where the actual “special comments” are. I have the following experiment code, to try and access all sorts of elements, mostly constru… --- ## [Escape '\*)' in documentation](https://discuss.ocaml.org/t/escape-in-documentation/6778)
**Author:** [@BikalGurung](https://discuss.ocaml.org/u/BikalGurung)\ **Replies:** 1\ **Last updated:** [November 16, 2020, 12:10pm UTC](https://discuss.ocaml.org/t/escape-in-documentation/6778 "2020-11-16T12:10:41Z")
I am trying to document a function as below, val f : string -\> int (\*\* \[val f s\] converts \[s\] to \[int\] {\[ let i = f "234asdfas" (\* Converts to int \*) \]} \*) How do I escape the \*) in code section, i.e. (\* Convert .… --- ## [Doc-comment workflows for ocaml?](https://discuss.ocaml.org/t/doc-comment-workflows-for-ocaml/5780)
**Author:** [@Chet\_Murthy](https://discuss.ocaml.org/u/Chet_Murthy)\ **Replies:** 2\ **Last updated:** [May 15, 2020, 10:38pm UTC](https://discuss.ocaml.org/t/doc-comment-workflows-for-ocaml/5780 "2020-05-15T22:38:47Z")
I’m not sure where to ask this question, so I figured I’d ask it here. I’m trying to understand all the various doc-comment extraction tools that exist in the Ocaml world, and specifically the ones that are “common”/“po… --- ## [Owl - generating docs](https://discuss.ocaml.org/t/owl-generating-docs/4207)
**Author:** [@atzensepp](https://discuss.ocaml.org/u/atzensepp)\ **Replies:** 2\ **Last updated:** [August 6, 2019, 6:41pm UTC](https://discuss.ocaml.org/t/owl-generating-docs/4207 "2019-08-06T18:41:11Z")
The Owl-Documentation seems inconsistent with the 0.6.0-release. Algorithmic Differentiation So for example Vec is not included. Try and error is tedious so I am wondering it it is possible to automatically generate … --- ## [Ocamldoc vs odoc right align](https://discuss.ocaml.org/t/ocamldoc-vs-odoc-right-align/4155)
**Author:** [@sanette](https://discuss.ocaml.org/u/sanette)\ **Replies:** 4\ **Last updated:** [July 27, 2019, 11:37am UTC](https://discuss.ocaml.org/t/ocamldoc-vs-odoc-right-align/4155 "2019-07-27T11:37:35Z")
Hello I currently use old ocamldoc to produce my doc. In trying to switch to odoc, I get the following error when running dune build @doc: File "lib/bogue.mli", line 36, characters 0-25: '{R {{:graph-b\_utils.html}': b… --- ## [Proposal: ocamldoc should generate a table of contents in each module page](https://discuss.ocaml.org/t/proposal-ocamldoc-should-generate-a-table-of-contents-in-each-module-page/871)
**Author:** [@yawaramin](https://discuss.ocaml.org/u/yawaramin)\ **Replies:** 2\ **Last updated:** [September 30, 2017, 5:05pm UTC](https://discuss.ocaml.org/t/proposal-ocamldoc-should-generate-a-table-of-contents-in-each-module-page/871 "2017-09-30T17:05:14Z")
Example is below. As you can see, the table of contents hyperlinks each name to the name’s documentation within the same page. This allows the reader to easily scan the TOC (which is helped by including the first line of…