ocaml-doc / doc-ock

(DEPRECATED) Documentation generation for OCaml
ISC License
15 stars 4 forks source link

Resolution regression in switch to Octavius #54

Closed dsheets closed 9 years ago

dsheets commented 9 years ago

3d4136f8f892908a28471656d180fc051223f5aa caused resolution regressions at least in:

Also, comments for containers (modules, module types, class, class types) should resolve relative to the container and not relative to the container's parent.

dsheets commented 9 years ago

Any progress on this? I tried to track down the top comment and tag field issues but gave up during the env mutation in lookup.

lpw25 commented 9 years ago

I'll have a look this afternoon. Is is only references to local things that are broken in the top module comments? What precisely do you mean by tag fields?

dsheets commented 9 years ago

The free form text in a tag:

@raise Invalid_argument when {!x} isn't a {!M.t}!

I don't think tag arguments can generally contain references so I've not tested that.

Here are the comment reference resolution issues as I understand them:

lpw25 commented 9 years ago

The issue with top-comments and other container comment scope issues should be resolved by https://github.com/lpw25/doc-ock/commit/8bde737217098a034200d8fbcc1db54975743f40.

The issue with tag fields should be resolved by: https://github.com/lpw25/doc-ock/commit/31b843a2fee58ca7f495bf0c98c681bab4e2dc27.

dsheets commented 9 years ago

Excellent! Thanks!

dsheets commented 9 years ago

Oops, the compilation unit references still seem unresolved but that may be on my end.