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

Missing documentation for many modules #8315

Closed
vicuna opened this issue Oct 6, 2003 · 3 comments
Closed

Missing documentation for many modules #8315

vicuna opened this issue Oct 6, 2003 · 3 comments
Labels

Comments

@vicuna
Copy link

vicuna commented Oct 6, 2003

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

Bug description

Full_Name: john Skaller
Version: CVS
OS:
Submission from: 203-213-127-159-syd-ts20-2600.tpgi.com.au (203.213.127.159)

Many modules have no proper documentation, for example
the functions of the Set module are not documented.

This is probably a bug (SERIOUS!) in ocamldoc. Here is the
complete page I see for the Set module:

Previous Up Next
Module Set

module Set: sig end

Sets over ordered types.

This module implements the set data structure, given a total ordering function
over the set elements. All operations over sets are purely applicative (no
side-effects). The implementation uses balanced binary trees, and is therefore
reasonably efficient: insertion and membership take time logarithmic in the size
of the set, for instance.

module type OrderedType = sig end

Input signature of the functor Set.Make.

module type S = sig end

Output signature of the functor Set.Make.

module Make: functor (Ord : OrderedType) -> sig end

Functor building an implementation of the set structure given a totally ordered
type.

@vicuna
Copy link
Author

vicuna commented Oct 6, 2003

Comment author: administrator

You can click on the module names to see their definition and contents.

  • Maxence Guesdon

@vicuna vicuna closed this as completed Oct 6, 2003
@vicuna
Copy link
Author

vicuna commented Oct 8, 2003

Comment author: administrator

On Mon, 2003-10-06 at 17:45, Maxence Guesdon wrote:

You can click on the module names to see their definition and contents.

  • Maxence Guesdon

Ah, ok. I see the problem. Its a bit messy.
It isn't necessary to do this for a single module
file like Array, but it is for a functor where
more than one module is defined (cause that's the way
ocamldoc works).

Ok. Thx.

BTW: does ocamldoc handle polymorphic variants like
ordinary ones yet? [I really need that, since all my
unions are pm-variants]

@vicuna
Copy link
Author

vicuna commented Oct 8, 2003

Comment author: administrator

On Tue, 7 Oct 2003 22:42:00 +0200 (MET DST)
skaller@ozemail.com.au wrote:

On Mon, 2003-10-06 at 17:45, Maxence Guesdon wrote:

You can click on the module names to see their definition and contents.

  • Maxence Guesdon

Ah, ok. I see the problem. Its a bit messy.
It isn't necessary to do this for a single module
file like Array, but it is for a functor where
more than one module is defined (cause that's the way
ocamldoc works).

Ok. Thx.

BTW: does ocamldoc handle polymorphic variants like
ordinary ones yet? [I really need that, since all my
unions are pm-variants]

Sorry, not yet.

Regards,

Maxence

@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