New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
ocamldoc doesn't support module aliases #6471
Comments
Comment author: @dbuenzli I tried and I'd say that from a documentation/usability perspective it's not very good for the following reasons.
|
Comment author: @zoggy Ok, I understand. Regarding point 2., there are two options: b) add one pass to look for aliased modules, to automatically mark them as not being generated and not appearing in the module list. This may be problematic if you want aliased module but still want them to appear in the list. An additional command line switch could prevent aliased module from being hidden. I still have to test about the way I can use information from module A in module B when we have module B = A . |
/cc @Octachron who I believe is responsible for ocamldoc these days. I'm neither sure whether this may have been solved nor whether it should be solved. I think we should focus API doc efforts on |
The point 2 is still unimplemented, but I agree that this feature is beyond the scope of ocamldoc maintenance. |
Original bug ID: 6471
Reporter: @dbuenzli
Assigned to: @zoggy
Status: assigned (set by @zoggy on 2014-06-27T06:17:35Z)
Resolution: reopened
Priority: normal
Severity: minor
Version: 4.02.0+beta1 / +rc1
Category: ocamldoc
Monitored by: @hcarty
Bug description
mkdir /tmp/test
cd /tmp/test
echo "module B = Test_b" > test.mli
echo "(** Module B synopsis *)" > test_b.mli
ocamlc test.mli
ocamlc test_b.mli
ocamldoc -html test.mli
I expect to be able to jump in the documentation of test_b.mli when I click on B in the documentation of Test.
Steps to reproduce
Fixed in rev 14992 in version/4.02 branch. It also fixes missing links for module aliases with no dot in the aliased module name.
Can you give it a try ?
The text was updated successfully, but these errors were encountered: