# Odoc: unattached documentation comment

**URL:** <https://discuss.ocaml.org/t/odoc-unattached-documentation-comment/3533>\
**Category:** Ecosystem\
**Tags:** odoc\
**Created:** [March 20, 2019, 8:43am UTC](https://discuss.ocaml.org/t/odoc-unattached-documentation-comment/3533 "2019-03-20T08:43:57Z")\
**Posts on this page:** 3\
**Page:** 1

<div class="post-metadata">

**Author:** ![Chris00](https://sea2.discourse-cdn.com/flex020/user_avatar/discuss.ocaml.org/chris00/32/48_2.png) [@Chris00](https://discuss.ocaml.org/u/Chris00)\
**Post date:** [March 20, 2019, 8:43am UTC](https://discuss.ocaml.org/t/odoc-unattached-documentation-comment/3533/1 "2019-03-20T08:43:57Z")

</div>

Hi,

In some packages, I have a (often long) comment at the bottom of the `.mli` file — unattached to any element — that gives some general information or some tips about the module. What it the recommended way of having it taken into account by `odoc`?  
Best,  
C.

---

<div class="post-metadata">

**Author:** ![Chris00](https://sea2.discourse-cdn.com/flex020/user_avatar/discuss.ocaml.org/chris00/32/48_2.png) [@Chris00](https://discuss.ocaml.org/u/Chris00)\
**Post date:** [March 20, 2019, 9:41am UTC](https://discuss.ocaml.org/t/odoc-unattached-documentation-comment/3533/2 "2019-03-20T09:41:44Z")

</div>

ATM, I am using an `index.mld` but the problem is that cross-references between the index and modules are not properly resolved.

---

<div class="post-metadata">

**Author:** ![dbuenzli](https://sea2.discourse-cdn.com/flex020/user_avatar/discuss.ocaml.org/dbuenzli/32/18_2.png) [@dbuenzli](https://discuss.ocaml.org/u/dbuenzli)\
**Post date:** [March 20, 2019, 12:25pm UTC](https://discuss.ocaml.org/t/odoc-unattached-documentation-comment/3533/3 "2019-03-20T12:25:22Z")

</div>

> [@Chris00](#):
>
> I have a (often long) comment at the bottom of the `.mli` file

I use this pattern in quite a few places in my modules and I don’t think I ever saw this problem. Could you please file an issue with a way to reproduce `odoc`’s issue tracker ?

> [@Chris00](#):
>
> ATM, I am using an `index.mld` but the problem is that cross-references between the index and modules are not properly resolved.

There are quite a few reasons why this might be the case. Do you see that both if you generate with `dune` and `odig ` (do an `opam pin . && odig doc -u YOURPKG`) ? Are your cross references inter-packages ?