Skip to content

Commit a5c31e7

Browse files
committed
Regenerate API documentation from modernize branch mli files
1 parent 6ebad63 commit a5c31e7

21 files changed

Lines changed: 33 additions & 1033 deletions

doc/dev/api/Config.wiki

Lines changed: 5 additions & 1 deletion
Large diffs are not rendered by default.

doc/dev/api/Extensions.wiki

Lines changed: 9 additions & 9 deletions
Large diffs are not rendered by default.

doc/dev/api/Lib.wiki

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
=Module <<a_api_type | module Lib >> =
22
<<pre class="ocsforge_color odocwiki_code"|<<span class="ocsforge_color_keyword"|module>> <<span class="ocsforge_color_uid"|<<span class="ocsforge_color_uid"|Lib>>>> <<span class="ocsforge_color_delimiter"|~:>> <<span class="ocsforge_color_keyword"|sig>><<a_api text=".." | module Lib >><<span class="ocsforge_color_keyword"|end>>>>~This module contains some auxiliaries for the ~Ocsigenserver~. ~In contrast to
3-
<<a_api | module Ocsigen_lib_base >>~, the function may also refer to libraries other than the
3+
<<span class="odocwiki_inlinecode"|~Ocsigen~_lib~_base>>~, the function may also refer to libraries other than the
44
standard library~.
55

66
----
7-
<<pre class="ocsforge_color odocwiki_code"|<<span class="ocsforge_color_keyword"|include>> <<a_api | module Ocsigen_lib_base >>>>
7+
<<pre class="ocsforge_color odocwiki_code"|<<span class="ocsforge_color_keyword"|include>> Ocsigen_lib_base>>
88
<<pre id="VALmake_cryptographic_safe_string" class="ocsforge_color odocwiki_code"|<<span class="ocsforge_color_keyword"|val>> <<span class="odocwiki_name"|make~_cryptographic~_safe~_string>> <<span class="ocsforge_color_delimiter"|~:>> <<span class="odocwiki_type"|unit <<span class="ocsforge_color_delimiter"| -> >> string>>>><<div class="odocwiki_info"|~Generate an unique and cryptographically safe random string~.
99
~It is impossible to guess for other people and
1010
will never return twice the same value ~(with very good probabilities~)~.

doc/dev/api/Ocsigen_cohttp.wiki

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
=Module <<a_api_type | module Ocsigen_cohttp >> =
22
<<pre class="ocsforge_color odocwiki_code"|<<span class="ocsforge_color_keyword"|module>> <<span class="ocsforge_color_uid"|<<span class="ocsforge_color_uid"|Ocsigen_cohttp>>>> <<span class="ocsforge_color_delimiter"|~:>> <<span class="ocsforge_color_keyword"|sig>><<a_api text=".." | module Ocsigen_cohttp >><<span class="ocsforge_color_keyword"|end>>>>
33
----
4-
<<pre id="VALsection" class="ocsforge_color odocwiki_code"|<<span class="ocsforge_color_keyword"|val>> <<span class="odocwiki_name"|section>> <<span class="ocsforge_color_delimiter"|~:>> <<span class="odocwiki_type"|<<span class="ocsforge_color_uid"|Logs>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_lid"|src>>>>>><<pre id="EXCEPTIONOcsigen_http_error" class="ocsforge_color odocwiki_code"|<<span class="ocsforge_color_keyword"|exception>> <<span class="odocwiki_name"|Ocsigen_http_error>> <<span class="ocsforge_color_keyword"|of>> <<span class="odocwiki_type"|<<a_api text="Ocsigen_cookie_map.t" | type Ocsigen_cookie_map.t >> * <<span class="ocsforge_color_uid"|Cohttp>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_uid"|Code>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_lid"|status>>>>>><<pre id="EXCEPTIONExt_http_error" class="ocsforge_color odocwiki_code"|<<span class="ocsforge_color_keyword"|exception>> <<span class="odocwiki_name"|Ext_http_error>> <<span class="ocsforge_color_keyword"|of>> <<span class="odocwiki_type"|\\  <<span class="ocsforge_color_uid"|Cohttp>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_uid"|Code>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_lid"|status>> * string option * <<span class="ocsforge_color_uid"|Cohttp>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_uid"|Header>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_lid"|t>> option>>>><<div class="odocwiki_info"|~Exception raised by exceptions to describe an ~H~T~T~P error~. ~It is
4+
<<pre id="VALsection" class="ocsforge_color odocwiki_code"|<<span class="ocsforge_color_keyword"|val>> <<span class="odocwiki_name"|section>> <<span class="ocsforge_color_delimiter"|~:>> <<span class="odocwiki_type"|<<span class="ocsforge_color_uid"|Logs>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_lid"|src>>>>>><<pre id="EXCEPTIONOcsigen_http_error" class="ocsforge_color odocwiki_code"|<<span class="ocsforge_color_keyword"|exception>> <<span class="odocwiki_name"|Ocsigen_http_error>> <<span class="ocsforge_color_keyword"|of>> <<span class="odocwiki_type"|<<span class="ocsforge_color_uid"|Ocsigen_cookie_map>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_lid"|t>> * <<span class="ocsforge_color_uid"|Cohttp>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_uid"|Code>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_lid"|status>>>>>><<pre id="EXCEPTIONExt_http_error" class="ocsforge_color odocwiki_code"|<<span class="ocsforge_color_keyword"|exception>> <<span class="odocwiki_name"|Ext_http_error>> <<span class="ocsforge_color_keyword"|of>> <<span class="odocwiki_type"|\\  <<span class="ocsforge_color_uid"|Cohttp>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_uid"|Code>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_lid"|status>> * string option * <<span class="ocsforge_color_uid"|Cohttp>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_uid"|Header>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_lid"|t>> option>>>><<div class="odocwiki_info"|~Exception raised by exceptions to describe an ~H~T~T~P error~. ~It is
55
possible to pass the code of the error~, an optional comment~, and
66
optionally some headers~.
77
>>

doc/dev/api/Ocsigen_lib_base.String_base.wiki

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515
removing spaces~.
1616
~For ex "azert~, sdfmlskdf~, dfdsfs"~.
1717
>>
18+
<<pre id="VALstarts_with" class="ocsforge_color odocwiki_code"|<<span class="ocsforge_color_keyword"|val>> <<span class="odocwiki_name"|starts~_with>> <<span class="ocsforge_color_delimiter"|~:>> <<span class="odocwiki_type"|<<span class="ocsforge_color_label"| prefix: >>string <<span class="ocsforge_color_delimiter"| -> >> string <<span class="ocsforge_color_delimiter"| -> >> bool>>>><<div class="odocwiki_info"|~Same as <<span class="odocwiki_inlinecode"|~Stdlib~.~String~.starts~_with>>~.
19+
>>
1820
<<pre id="VALmay_append" class="ocsforge_color odocwiki_code"|<<span class="ocsforge_color_keyword"|val>> <<span class="odocwiki_name"|may~_append>> <<span class="ocsforge_color_delimiter"|~:>> <<span class="odocwiki_type"|string <<span class="ocsforge_color_delimiter"| -> >> <<span class="ocsforge_color_label"| sep: >>string <<span class="ocsforge_color_delimiter"| -> >> string <<span class="ocsforge_color_delimiter"| -> >> string>>>><<pre id="VALmay_concat" class="ocsforge_color odocwiki_code"|<<span class="ocsforge_color_keyword"|val>> <<span class="odocwiki_name"|may~_concat>> <<span class="ocsforge_color_delimiter"|~:>> <<span class="odocwiki_type"|string <<span class="ocsforge_color_delimiter"| -> >> <<span class="ocsforge_color_label"| sep: >>string <<span class="ocsforge_color_delimiter"| -> >> string <<span class="ocsforge_color_delimiter"| -> >> string>>>><<pre id="VALfirst_diff" class="ocsforge_color odocwiki_code"|<<span class="ocsforge_color_keyword"|val>> <<span class="odocwiki_name"|first~_diff>> <<span class="ocsforge_color_delimiter"|~:>> <<span class="odocwiki_type"|string <<span class="ocsforge_color_delimiter"| -> >> string <<span class="ocsforge_color_delimiter"| -> >> int <<span class="ocsforge_color_delimiter"| -> >> int <<span class="ocsforge_color_delimiter"| -> >> int>>>><<div class="odocwiki_info"|<<span class="odocwiki_inlinecode"|first~_diff s~1 s~2 n last>> returns the index of the first difference
1921
between s~1 and s~2~, starting from n and ending at last~.
2022
returns ~(last ~+ ~1~) if no difference is found~.

doc/dev/api/Ocsigen_lib_base.wiki

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
=Module <<a_api_type | module Ocsigen_lib_base >> =
22
<<pre class="ocsforge_color odocwiki_code"|<<span class="ocsforge_color_keyword"|module>> <<span class="ocsforge_color_uid"|<<span class="ocsforge_color_uid"|Ocsigen_lib_base>>>> <<span class="ocsforge_color_delimiter"|~:>> <<span class="ocsforge_color_keyword"|sig>><<a_api text=".." | module Ocsigen_lib_base >><<span class="ocsforge_color_keyword"|end>>>>~This module just contains only extensions of the standard library and very
3-
basic ~Ocsigen values and exceptions~. ~Cf~. <<a_api | module Lib >> for functionality
3+
basic ~Ocsigen values and exceptions~. ~Cf~. <<span class="odocwiki_inlinecode"|~Lib>> for functionality
44
which depends on specific external libraries~.
55

66
----

doc/dev/api/Outputfilter.wiki

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
~This module belongs to ocamlfind package
1414
<<span class="odocwiki_inlinecode"|ocsigenserver~.ext~.outputfilter>>~.
1515

16-
~See an example of use on the ~A~P~I documentation of <<a_api | module Revproxy >>~.
16+
~See an example of use on the ~A~P~I documentation of <<span class="odocwiki_inlinecode"|~Revproxy>>~.
1717
<<pre id="VALrun" class="ocsforge_color odocwiki_code"|<<span class="ocsforge_color_keyword"|val>> <<span class="odocwiki_name"|run>> <<span class="ocsforge_color_delimiter"|~:>> <<span class="odocwiki_type"|\\  <<span class="ocsforge_color_label"| mode: >>[ `Add of <<span class="ocsforge_color_uid"|Ocsigen_http>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_uid"|Header>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_uid"|Name>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_lid"|t>> * string * bool option\\   | `Code of <<span class="ocsforge_color_uid"|Cohttp>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_uid"|Code>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_lid"|status>>\\   | `Rewrite of <<span class="ocsforge_color_uid"|Ocsigen_http>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_uid"|Header>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_uid"|Name>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_lid"|t>> * string * string ] <<span class="ocsforge_color_delimiter"| -> >>\\  unit <<span class="ocsforge_color_delimiter"| -> >> <<span class="ocsforge_color_uid"|Ocsigen>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_uid"|Server>><<span class="ocsforge_color_delimiter"| . >><<span class="ocsforge_color_lid"|instruction>>>>>><<div class="odocwiki_info"|<<span class="odocwiki_inlinecode"|run ~~mode ~(~)>> makes it possible to use this extension without
1818
configuration file~.
1919
>>

doc/dev/api/Request.wiki

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)