Skip to content
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

-keep-code and source code browsing #4443

Closed
vicuna opened this issue Nov 10, 2007 · 0 comments
Closed

-keep-code and source code browsing #4443

vicuna opened this issue Nov 10, 2007 · 0 comments

Comments

@vicuna
Copy link

vicuna commented Nov 10, 2007

Original bug ID: 4443
Reporter: @dbuenzli
Assigned to: @zoggy
Status: closed (set by @zoggy on 2007-11-12T08:47:49Z)
Resolution: won't fix
Priority: normal
Severity: feature
Version: 3.10.0
Category: ocamldoc
Monitored by: @dbuenzli

Bug description

Hello Maxence,

Regarding html generation with -keep-code, a nice feature would be to link symbols to their implementation (when available) in the implementation pages. This would turn our browsers into source code browsers. Very useful to understand how a project works.

Best,

Daniel

Additional information

It's not an easy thing to do, since all expressions must be analysed and names resolved regarding an environment. The current html generator is more oriented to produce "reference documentation", where browsing of source code should not be needed if comments are well written.
You can always create your own custom generator which overrides some methods of the default html generator...

Regards,

Maxence

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant