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

ocamldoc syntax error on <code> #6026

Closed
vicuna opened this issue May 31, 2013 · 2 comments
Closed

ocamldoc syntax error on <code> #6026

vicuna opened this issue May 31, 2013 · 2 comments

Comments

@vicuna
Copy link

vicuna commented May 31, 2013

Original bug ID: 6026
Reporter: Hendrik Tews
Assigned to: @zoggy
Status: closed (set by @zoggy on 2013-08-05T08:59:14Z)
Resolution: fixed
Priority: normal
Severity: minor
Version: 4.00.0
Target version: 4.01.0+dev
Fixed in version: 4.01.0+dev
Category: ocamldoc

Bug description

Hi,

ocamldoc seems to recognize and interpred some html tags. For instance, (** ) triggers a syntax error while (* *) works fine.

The problem is that this feature and the set of recognized tags is not documented.

I would suggest to either remove this feature or to document it.

Bye,

Hendrik

@vicuna
Copy link
Author

vicuna commented May 31, 2013

Comment author: @gasche

Looking at the code, HTML syntaxes were implemented "since the beginning" (2002 in the repo history) for ocamldoc. For example, instead of the code syntax
[List.map foo bar]
you may use the following
List.map foo bar

The other supported tags are <b, <i, <ul, <ol, <li and <center for {b..}, {i..}, {ul..}, {ol..}, {li..} and {C..}, as well as <h[0-9] for hierarchic titles.

Tag parsing is case-insensitive:

is also accepted.

@vicuna
Copy link
Author

vicuna commented Aug 5, 2013

Comment author: @zoggy

These tags are now documented and will appear in the next version of the documentation.

@vicuna vicuna closed this as completed Aug 5, 2013
@vicuna vicuna added this to the 4.01.0 milestone Mar 14, 2019
@vicuna vicuna added the bug label Mar 20, 2019
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