summaryrefslogtreecommitdiff
path: root/ocamldoc/odoc_man.ml
Commit message (Collapse)AuthorAgeFilesLines
* Merge pull request #11060 from shindere/spring-cleanupSébastien Hinderer2022-03-011-1/+1
|\ | | | | Remove uses of ;; from the codebase (spring cleanup)
| * Remove uses of ;; from the codebaseSébastien Hinderer2022-02-251-1/+1
| |
* | ocamldoc: Render alerts before custom tagsJules Aguillon2022-02-221-1/+1
| |
* | ocamldoc: Support alerts in other backendsJules Aguillon2022-02-221-2/+20
|/ | | | | And render a '.' after the alert name. This is how the deprecated tag is rendered. We expect a sentence in the payload.
* Fix "Deprecated. " throughoutJohn Whitington2021-01-121-1/+1
|
* ocamldoc man: use .EX..EE in multi-line code blocksGabriel Scherer2019-11-141-1/+4
| | | | (Suggested by Florian Angeletti)
* ocamldoc: better support of multiline code blocks in the manpage backendGabriel Scherer2019-11-141-7/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | Before, `man Map` would show: ``` For instance: module IntPairs = struct type t = int * int let compare (x0,y0) (x1,y1) = match Stdlib.compare x0 x1 with 0 -> Stdlib.compare y0 y1 | c -> c end module PairsMap = Map.Make(IntPairs) let m = PairsMap.(empty |> add (0,1) hello |> add (1,0) world ) ``` Now it shows: ``` For instance: module IntPairs = struct type t = int * int let compare (x0,y0) (x1,y1) = match Stdlib.compare x0 x1 with 0 -> Stdlib.compare y0 y1 | c -> c end module PairsMap = Map.Make(IntPairs) let m = PairsMap.(empty |> add (0,1) "hello" |> add (1,0) "world") ``` (in both cases the code is in bold)
* Remove Misc.may_map and similarLeo White2019-05-231-1/+1
|
* ocamldoc, manpage backend: unwrap module comment docstrings (#2114)Florian Angeletti2018-10-241-3/+4
| | | | | | * unwrap non-code doctstring * use .SS for ocamldoc titles * update Changes
* ocamldoc: improve printing of subscript/superscript in 'man' formatGabriel Scherer2018-04-091-2/+2
| | | | | | | | | | | | | | | | | | | | On a standard OCaml install, `man Nativeint` shows the following sentence in its first paragraph: All arithmetic operations over nativeint are taken modulo 2^{32 or 2^{64 depending on the word size of the architecture. The `2^{32` is a rendering bug. This PR removes the unbalanced curvy bracket, so it prints 2^32 and 2^64 instead. In theory just printing ^ and _ risks creating ambiguities for multi-words superscripts or subscripts: "2^foo bar" could be either "2^{foo bar}" or "2^{foo} bar". In practice, the ocamldoc text in the standard library only uses the superscript for bit sizes. Even for arbitrary user documentation comments, "^{" or "^" have the same property of not being explicit about where the superscript ends, so this would not be a regression even on multi-word superscripts.
* Typos and basic grammar error fixing (#1280)Fourchaux2017-08-101-1/+1
|
* MPR#7281: fix .TH macros in generated manpagesOlaf Hering2017-07-241-5/+5
| | | | | | | | | | | | | | The troff .TH macro takes up to three extra args, according to the groff documentation at gnu.org. ocamldoc inserts a fourth argument "source:". Remove the extra argument. Fixes commit a87c3f20e ("Enable ocamldoc to build reproducible manpages") Without this change the header/footer of each ocaml manpage is broken. Example: the date should be in the middle of footer, instead of the left side. The string "source:" should not be shown at all. No other manpage has such string. Signed-off-by: Olaf Hering <olaf@aepfle.de>
* Ocamldoc: improve support for inline recordsoctachron2016-07-281-26/+30
| | | | | | | This commit improves support for inline record and associated documentation within ocamldoc. Note that the support for documentation on inline record field could be improved in the various ocamldoc backends.
* More warnings for ocamldoc.Alain Frisch2016-03-151-9/+8
|
* Update headers for the new license.Damien Doligez2016-02-181-11/+14
| | | | Remains to be done: remove all headers in testsuite/tests.
* Remove useless bindings, use proper sequencing instead of 'let _ = ... in ...'.alainfrisch2016-01-201-6/+4
|
* Enable ocamldoc to build reproducible manpagesValentin Lorentz2015-11-291-10/+5
| | | | | Bug-Debian: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=794586 Signed-off-by: Stephane Glondu <steph@glondu.net>
* Translation of french comments in odocGabriel Scherer2015-10-091-1/+1
| | | | | | (user 'octachron') git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@16482 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
* PR6695: Make sure the compiler only uses ASCII string functions.Gabriel Scherer2014-12-211-1/+1
| | | | | | | | | | This should cover all places involving filenames in the compiler. There are a few more paths still using Latin-1 in other ways, e.g. in ocamldoc. From: Peter Zotov <whitequark@whitequark.org> git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@15727 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
* Reintegrate-merge constructors_with_record5 branch.Alain Frisch2014-10-141-20/+27
|\ | | | | | | git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@15556 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
* | merge changes from branch 4.02 from branching (rev 14852) to 4.02.0+rc1 (rev ↵Damien Doligez2014-08-221-1/+1
| | | | | | | | | | | | 15121) git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@15125 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
* | PR#6274: allow doc comments on object typesMaxence Guesdon2014-05-221-70/+73
| | | | | | | | | | | | | | (thanks to Thomas Refis) git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@14909 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
* | PR#6425: fix generation of man pages, handling variant constructors and ↵Maxence Guesdon2014-05-221-78/+150
| | | | | | | | | | | | record fields git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@14902 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
* | PR#5584: merge open extensible types, extension-patch-4.0.2Jacques Garrigue2014-05-041-5/+96
|/ | | | git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@14737 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
* merge generative functorsJacques Garrigue2013-12-171-1/+1
| | | | git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@14365 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
* PR#6257: allow full doc comments on variant constructors and record fieldsMaxence Guesdon2013-12-091-107/+132
| | | | git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@14343 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
* remove all $Id keywordsDamien Doligez2012-10-151-2/+0
| | | | git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@13013 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
* fix formatting of copyright headersDamien Doligez2012-08-011-0/+1
| | | | git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@12803 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
* fix TABs and whitespaceDamien Doligez2012-07-301-2/+2
| | | | git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@12797 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
* merge changes from 4.00 branching to 4.00.0 (part 1)Damien Doligez2012-07-261-2/+6
| | | | git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@12784 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
* ocamldoc now updated. odoc_sig.ml was changed from revision 1660Jacques Le Normand2010-10-011-5/+31
| | | | git-svn-id: http://caml.inria.fr/svn/ocaml/branches/gadts@10698 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
* use first-class modules to allow composition of custom generatorsMaxence Guesdon2010-08-241-13/+24
| | | | git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@10652 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
* PR#4831: handle @before tag in ocamldocMaxence Guesdon2010-05-311-0/+17
| | | | git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@10480 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
* PR#4915: new syntax {%format: code %} to put target format specific codeMaxence Guesdon2010-03-081-0/+4
| | | | git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@9638 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
* PR#4914: ability to specify a text for links to elementsMaxence Guesdon2009-12-181-1/+1
| | | | git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@9477 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
* PR#4630: minor fix in ocamldoc man page generationMaxence Guesdon2008-10-291-4/+6
| | | | git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@9112 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
* fix bug #4585 and handle virtual flag for class value in all generatorsMaxence Guesdon2008-07-231-0/+1
| | | | git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@8927 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
* It works: compilers and camlp4 are fully bootstrapped. The ast magic number ↵Pierre Weis2007-10-091-2/+4
| | | | | | is not yet changed. git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@8418 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
* fusion 3.09.0 -> 3.09.1Damien Doligez2006-01-041-188/+191
| | | | git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@7307 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
* fusion des modifs de 3.08.4Damien Doligez2005-08-131-2/+11
| | | | git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@7019 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
* fusion des changements jusqu'a 3.08.3Damien Doligez2005-03-241-18/+15
| | | | git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@6824 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
* fix unused variablesMaxence Guesdon2004-12-031-74/+74
| | | | git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@6723 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
* new ocamldoc syntax elements : {\!modules: M1 M2 ...} to insert the table of ↵Maxence Guesdon2004-05-231-0/+4
| | | | | | modules, {\!indexlist} to insert the list of indexes; these elements are used only in the html generator; the -intro option is now used in html to describe the whole index page git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@6313 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
* OK - fix: useless parenthesis around agruments of arguments of a type ↵Maxence Guesdon2004-03-221-5/+7
| | | | | | | | | | | constructor in type definitions, and aournd arguments of exceptions in exception definitions. OK - fix: blank lines in verbatim, latex, code pre, code and ele ref modes are now accepted git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@6162 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
* use buffers instead of string concatenation in html and man generatorsMaxence Guesdon2004-03-141-475/+571
| | | | git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@6155 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
* new module odoc_print, will work when Format.pp_print_flush is fixedMaxence Guesdon2004-03-051-3/+3
| | | | git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@6135 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
* added $Id$ keywordsBasile Starynkevitch2003-11-241-0/+1
| | | | git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@5973 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
* fix display of include directives and comments associated to include ↵Maxence Guesdon2003-11-211-0/+2
| | | | | | directives are not kept and displayed git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@5941 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
* fix bad display of type parameters for class and class typesMaxence Guesdon2003-10-171-2/+2
| | | | git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@5874 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
* fix: bad display of values, methods, attributes, types, due to bad use of ↵Maxence Guesdon2003-09-131-2/+2
| | | | | | Format.str_formatter git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@5833 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
View Lorry Controller Status