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 fait disparaitre de la doc #3770

Closed
vicuna opened this issue Aug 24, 2005 · 2 comments
Closed

ocamldoc fait disparaitre de la doc #3770

vicuna opened this issue Aug 24, 2005 · 2 comments
Labels

Comments

@vicuna
Copy link

vicuna commented Aug 24, 2005

Original bug ID: 3770
Reporter: administrator
Status: closed
Resolution: not a bug
Priority: normal
Severity: minor
Category: ~DO NOT USE (was: OCaml general)

Bug description

/usr/local/ocaml-3.08/bin/ocamldoc.opt -version
OCamldoc 3.08.1

Le source suivant:
type bufpolicy =
[ Block (** General block buffering (general default). )
| Line (
* Line buffering (tty default). )
| Nobuf (
* Direct I/O --- no buffering. )
]
;
produit des fichiers (.dvi comme .html) où la dernière alternative du
type n'est pas documentée. De même:
type bufpolicy =
[ Block (
* General block buffering (general default). )
| Line (
* Line buffering (tty default). )
| Nobuf (
* Direct I/O --- no buffering. )
]
; (
* )
Par contre,
type bufpolicy =
[ Block (
* General block buffering (general default). )
| Line (
* Line buffering (tty default). )
| Nobuf ] (
* Direct I/O --- no buffering. )
; (
* *)
ne supprime pas la documentation de Nobuf.

Bien que le dernier cas fournisse un contournement (pas simple à
réinventer), ça n'en reste pas moins un bogue: de l'info (de la doc)
disparaît sans message d'erreur, sans autre moyen de s'en rendre
compte que par inspection des fichiers générés. S'ils sont gros, si
la documentation évolue, on a toutes les chances de retomber dans le
piège.

Bruno.

@vicuna
Copy link
Author

vicuna commented Aug 29, 2005

Comment author: administrator

On Wed, 24 Aug 2005 12:35:16 +0200 (MET DST)
Bruno.Verlyck@inria.fr wrote:

/usr/local/ocaml-3.08/bin/ocamldoc.opt -version
OCamldoc 3.08.1

Le source suivant:
type bufpolicy =
[ Block (** General block buffering (general default). )
| Line (
* Line buffering (tty default). )
| Nobuf (
* Direct I/O --- no buffering. )
]
;
produit des fichiers (.dvi comme .html) où la dernière alternative du
type n'est pas documentée. De même:
type bufpolicy =
[ Block (
* General block buffering (general default). )
| Line (
* Line buffering (tty default). )
| Nobuf (
* Direct I/O --- no buffering. )
]
; (
* )
Par contre,
type bufpolicy =
[ Block (
* General block buffering (general default). )
| Line (
* Line buffering (tty default). )
| Nobuf ] (
* Direct I/O --- no buffering. )
; (
* *)
ne supprime pas la documentation de Nobuf.

Bien que le dernier cas fournisse un contournement (pas simple à
réinventer), ça n'en reste pas moins un bogue: de l'info (de la doc)
disparaît sans message d'erreur, sans autre moyen de s'en rendre
compte que par inspection des fichiers générés. S'ils sont gros, si
la documentation évolue, on a toutes les chances de retomber dans le
piège.

Salut Bruno,

je pense que c'est un bug dans le parseur ou printer camlp4 de la syntaxe
révisée. Je laisse ça aux spécialistes de camlp4. Michel ? ;)

--
Maxence

@vicuna
Copy link
Author

vicuna commented Oct 21, 2005

Comment author: administrator

option -cip de pr_o.cmo.

@vicuna vicuna closed this as completed Oct 21, 2005
@vicuna vicuna added the bug label Mar 19, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant