johnwhitington / camlpdf

OCaml library for reading, writing and modifying PDF files
Other
200 stars 28 forks source link

The documentation is out of date with the code #37

Closed Bladtman242 closed 4 years ago

Bladtman242 commented 4 years ago

The documentation is out of date with the code.

Case in point: Pdfstandard14.afm_data returns a 4-tuple, not a tripple. Likewise, the textwidth function accepts an additional argument, the encoding, not listed in the html documentation.

johnwhitington commented 4 years ago

Here is the current documentation from the pdfstandard14.mli in trunk:

(* The data extracted from the font AFM. This is a 4-tuple, consisting of a table of header pairs, a table of (character number, width) pairs, a table of (first, second, kern) triples representing the kerning table and a table of (character name, width) pairs. The last table is useful for character which are identified with a custom encoding and which might not be assigned a number in the standard encoding. )

So HTML documentation generated from this should be correct.

What is the URL you are reading the HTML documentation at?

Bladtman242 commented 4 years ago

this url. I assumed it was just a matter of having forgot to rerun the doctool, but maybe I'm wrong.

johnwhitington commented 4 years ago

Indeed, it looks like this has not been updated since 2014(!). I have just updated it.

Bladtman242 commented 4 years ago

Thank you!