Commit Graph

124 Commits (master)

Author SHA1 Message Date
Sébastien Hinderer 433485b8b5 ocamldoc: remove debugging facility 2020-06-09 12:30:44 +02:00
Stephen Dolan f75d5f3174 Use Odoc_global.library_namespace for index alias removal 2020-05-25 11:12:28 +01:00
Stephen Dolan 6b214f5138 Ensure stdlib documentation index refers to Stdlib
Previously, some references were to Pervasives and some were missing.
2020-05-18 19:15:05 +01:00
David Allsopp 504d95c275 Fix formatting of closing brace in records 2019-11-21 12:06:53 +00:00
Florian Angeletti 642504c5e7 ocamldoc: add a -lib flag for prefixed libraries 2018-09-03 13:59:32 +01:00
octachron 00a0807e96 ocamldoc: adhoc support for prefixed stdlib 2018-09-03 13:59:32 +01:00
Gabriel Radanne 1be47bf7ab Just some tbl things. (#1699) 2018-07-23 13:19:41 +01:00
octachron 4583eb1a05 ocamldoc, html: add end line to please AppVeyor 2018-03-06 11:58:10 +01:00
objmagic 0993cd9ba9 Support empty variants (#1546)
* Allow empty variants.
* Update manual and ocamldoc.
2018-03-06 10:48:16 +09:00
octachron 03e1a93f0b PR#7363, ocamldoc: implicit level 0 for titles
This commit makes the heading hierarchy of ocamldoc start at {0 rather
than {1. This level {0 should be reserved for global titles, freeing
the use of {1 for normal subtitles.
2017-10-03 23:29:50 +02:00
octachron 9593af586f ocamldoc html: add missing id to signature items
This commit adds a new id to classes, modules and module types.
The class id replaces the preexisting name attribute that was intended
to be an id attribute.
2017-09-30 20:10:27 +02:00
Fourchaux 72cfdd56e9 Typos and basic grammar error fixing (#1280) 2017-08-10 11:59:23 +01:00
octachron f7ed665b3c ocamldoc: avoid nested <pre> in module description 2017-04-04 13:27:45 +02:00
octachron d069dbe585 MPR#7352,7353: ocamldoc, better paragraphs in html 2017-03-15 19:55:37 +01:00
octachron 9d97673b9f PR#7351: ocamldoc html, use tags rather than <br>
This commit replaces most of the use of <br> tags in ocamldoc html
backend by more meaningful tags, in order to improve the themability
of the generated html code.
2017-03-15 15:26:56 +01:00
Pierre Boutillier bb27a9803b Ocamldoc: no -title, no empty <h1> in html 2017-03-12 13:35:16 -04:00
Etienne Millon 857dd87a7b Fix XSS in ocamldoc
It is possible to craft comments that can expand to unfiltered HTML
fragments.

For example, the following program:

```ocaml
(** {{: "><script>alert(1)</script>"} } *)
let n = 0
```

Would generate a HTML file containing:

```html
<a href=" "><script>alert(1)</script>""> </a>
```

Using this technique it is possible to leak cookies to a third party.

The fix is not perfect since it does not generate usable documentation,
but the generated HTML is harmless.

Note that input like `{{: javascript:alert(1)} }` will still run
arbitrary JS but requires human interaction.
2016-12-07 13:15:06 +01:00
Etienne Millon c09e6b3842 Fix CSS color declaration
There is a typo in the generated CSS for link to modules in the index
page. CSS colors should start with `#`.

As a consequence, this also makes the default stylesheet valid according
to <https://jigsaw.w3.org/css-validator>.
2016-10-04 11:55:51 +02:00
octachron 788819687f PR#7350: ocamldoc, viewport metadata for html 2016-09-12 22:45:23 +02:00
octachron 142494cd46 PR#7272: ocamldoc, escape blanks outside of <pre>
With this commit, ocamldoc does not escape anymore space characters
within the <pre> </pre> tags and instead escape space and newline
characters inside <code> </code> when a <pre>-like behavior is desired.

Moreover, the type_* files generated by ocamldoc are correctly assigned
a <pre>-like behavior.
2016-09-08 02:21:47 +02:00
octachron 55282ebf5f Fix: preserve ocamldoc module info logic 2016-08-31 14:16:19 +02:00
octachron dcceb46358 Ocamldoc: improve support for inline records
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.
2016-07-28 02:21:16 +02:00
Alain Frisch b8e418e9f3 More warnings for ocamldoc. 2016-03-15 22:47:33 +01:00
Damien Doligez 5401ce8473 Update headers for the new license.
Remains to be done: remove all headers in testsuite/tests.
2016-02-18 16:59:16 +01:00
alainfrisch ae3af451b8 Remove useless bindings, use proper sequencing instead of 'let _ = ... in ...'. 2016-01-20 00:02:30 +01:00
Gabriel Scherer 1645e88824 PR#7096: ocamldoc uses an incorrect subscript/superscript style 2015-12-17 09:10:27 +01:00
Gabriel Scherer e9fdf20abf Translation of french comments in odoc
(user 'octachron')

git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@16482 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2015-10-09 20:41:51 +00:00
Gabriel Scherer f15f4f3ed8 PR6695: Make sure the compiler only uses ASCII string functions.
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
2014-12-21 11:46:14 +00:00
Alain Frisch e3ad818fb5 Reintegrate-merge constructors_with_record5 branch.
git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@15556 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2014-10-14 15:51:30 +00:00
Damien Doligez cbfe627f92 merge changes from branch 4.02 from branching (rev 14852) to 4.02.0+rc1 (rev 15121)
git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@15125 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2014-08-22 13:45:02 +00:00
Maxence Guesdon 1a3b58be2b PR#6274: allow doc comments on object types
(thanks to Thomas Refis)


git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@14909 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2014-05-22 13:38:29 +00:00
Jacques Garrigue b56dc4b3df PR#5584: merge open extensible types, extension-patch-4.0.2
git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@14737 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2014-05-04 23:08:45 +00:00
Jacques Garrigue cfa350c31a merge generative functors
git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@14365 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2013-12-17 03:52:50 +00:00
Maxence Guesdon ff754c0d66 PR#6257: allow full doc comments on variant constructors and record fields
git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@14343 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2013-12-09 08:33:44 +00:00
Maxence Guesdon cde8ad8a75 PR#5149: (point 15) add line breaks in html source before <pre> tags
git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@13991 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2013-08-12 06:37:59 +00:00
Maxence Guesdon 36c3ae71af ocamldoc|html: Add missing space in record fields
git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@13985 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2013-08-05 12:52:12 +00:00
Maxence Guesdon 6ad069c042 PR#5111: additional class for info tags
git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@13982 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2013-08-05 09:45:54 +00:00
Gabriel Scherer 75b8c0184f PR#5933 type-specialize 'let compare = compare' on ints and strings
According to the reporter 'sliquister', type-specialized comparison
can nearly halve compilation time in some cases. This patch applies
type-specialization throughout the OCaml distribution sources, so not
all changes will have performance utility, but in this case I think
it's best to be consistent, as I see no downside to the change.


git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@13410 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2013-03-19 07:22:12 +00:00
Damien Doligez def31744f9 remove all $Id keywords
git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@13013 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2012-10-15 17:50:56 +00:00
Maxence Guesdon dd78691ec4 PR#5111: description of module not put into a tag
git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@12954 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2012-09-25 07:51:21 +00:00
Maxence Guesdon 61789ae70d PR#5111: no more span around hX tags
git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@12887 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2012-08-27 11:52:01 +00:00
Maxence Guesdon 9fc3231cfe PR#5725: add pre tag also for -colorize-code
git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@12885 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2012-08-27 11:43:36 +00:00
Damien Doligez 015739ac70 fix formatting of copyright headers
git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@12803 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2012-08-01 12:09:31 +00:00
Damien Doligez b7271628a2 fix TABs and whitespace
git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@12797 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2012-07-30 11:52:38 +00:00
Damien Doligez 0c3a7de507 merge changes from 4.00 branching to 4.00.0 (part 1)
git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@12784 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2012-07-26 19:21:54 +00:00
Jacques Garrigue 9dc661c3bf merge branches/gadts
git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@11160 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2011-07-29 10:32:43 +00:00
Damien Doligez c91db736b1 merge changes from 3.12.0 to 3.12.1
git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@11123 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2011-07-20 09:17:07 +00:00
Jacques Le Normand 6b47423629 ocamldoc now updated. odoc_sig.ml was changed from revision 1660
git-svn-id: http://caml.inria.fr/svn/ocaml/branches/gadts@10698 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2010-10-01 03:44:47 +00:00
Maxence Guesdon 0936bb2811 use first-class modules to allow composition of custom generators
git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@10652 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2010-08-24 09:45:45 +00:00
Maxence Guesdon ef6ed63a78 change back for the bad quote introduced yesterday
git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@10493 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2010-06-04 05:37:50 +00:00