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

genlex full documentation #5211

Closed
vicuna opened this issue Jan 25, 2011 · 4 comments
Closed

genlex full documentation #5211

vicuna opened this issue Jan 25, 2011 · 4 comments

Comments

@vicuna
Copy link

vicuna commented Jan 25, 2011

Original bug ID: 5211
Reporter: william
Assigned to: @xclerc
Status: closed (set by @xavierleroy on 2012-09-25T18:07:20Z)
Resolution: fixed
Priority: normal
Severity: minor
Version: 3.12.0
Fixed in version: 3.12.1+dev
Category: documentation
Has duplicate: #5298

Bug description

the parser example in the Genlex documentation is not complete : it took me hours to compile a similar example with ocamlbuild.
First it is not "let parse_expr = parser [...]" but "let rec parse_expr = parser [...]".
Second, to compile this example in a file called example.ml, one needs to do :
echo "<example.ml>:pp(camlp4o)" > _tags
ocamlbuild example.d.byte

@vicuna
Copy link
Author

vicuna commented Jan 25, 2011

Comment author: william

the genlex documentation : http://caml.inria.fr/pub/docs/manual-ocaml/libref/Genlex.html

@glyh
Copy link

glyh commented Sep 17, 2023

Can't access this webpage, is there a place I can find it? Thanks.

p.s. I am aware that genlex is removed from ocaml std.

@gasche
Copy link
Member

gasche commented Sep 17, 2023

The old API page is missing from https://v2.ocaml.org/api/Genlex.html (where the link above redirects; it is just a blank page which is a bit weird) but it remains available at https://v2.ocaml.org/releases/4.14/api/Genlex.html .

Genlex has moved to https://github.com/ocaml/camlp-streams . You can read the .mli interface file with documentation comments at https://github.com/ocaml/camlp-streams/blob/trunk/src/genlex.mli . Currently there is no {ocamldoc,odoc}-generated documentation available online for this new package, but there are no API changes planned compared to the 4.14 version so the old documentation is just as good.

@dra27
Copy link
Member

dra27 commented Sep 17, 2023

I don't know why the documentation isn't in the main index at https://ocaml.org/p/camlp-streams/latest/doc/index.html is blank, but the odoc-generated documentation for Genlex is available by manually searching at https://ocaml.org/p/camlp-streams/latest/doc/Genlex/index.html.

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

4 participants