ocamldoc - Online sa Cloud

PROGRAMA:

NAME

ocamldoc - Ang OCaml documentation generator

SINOPSIS

ocamldoc [ pagpipilian ] filename ...

DESCRIPTION

Ang OCaml documentation generator ocamldoc(1) bumubuo ng dokumentasyon mula sa espesyal
mga komentong naka-embed sa mga source file. Ang mga komentong ginamit ng ocamldoc ay nasa anyo (** ...
*) at sundin ang format na inilarawan sa Ang OCaml ng gumagamit manwal.

ocamldoc maaaring gumawa ng dokumentasyon sa iba't ibang mga format: HTML, LaTeX, TeXinfo, Unix man
mga pahina, at tuldok(1) mga graph ng dependency. Bukod dito, ang mga gumagamit ay maaaring magdagdag ng kanilang sariling mga pasadyang generator.

Sa manpage na ito, ginagamit namin ang salita sangkap upang sumangguni sa alinman sa mga sumusunod na bahagi ng isang
OCaml source file: isang uri ng deklarasyon, isang halaga, isang module, isang exception, isang uri ng module, a
type constructor, isang record field, isang klase, isang uri ng klase, isang paraan ng klase, isang halaga ng klase o
isang class inheritance clause.

Opsyon

Tinutukoy ng mga sumusunod na opsyon sa command-line ang format para sa nabuong dokumentasyon
nabuo ng ocamldocNa (1).

Options para pagpili ang output format
-html Bumuo ng dokumentasyon sa HTML default na format. Ang nabuong mga pahina ng HTML ay iniimbak
sa kasalukuyang direktoryo, o sa direktoryong tinukoy kasama ng -d pagpipilian Kaya mo
i-customize ang istilo ng mga nabuong pahina sa pamamagitan ng pag-edit ng nabuo style.css file,
o sa pamamagitan ng pagbibigay ng iyong sariling style sheet gamit ang opsyon -css-style. Ang file style.css
ay hindi nabuo kung mayroon na.

-latex Bumuo ng dokumentasyon sa LaTeX default na format. Ang nabuong LaTeX na dokumento ay
naka-save sa file ocamldoc.out, o sa file na tinukoy kasama ng -o pagpipilian Ang
ginagamit ng dokumento ang style file ocamldoc.sty. Ang file na ito ay nabuo kapag ginagamit ang
-latex opsyon, kung wala pa ito. Maaari mong baguhin ang file na ito upang i-customize
ang istilo ng iyong dokumentasyon ng LaTeX.

-texi Bumuo ng dokumentasyon sa default na format ng TeXinfo. Ang nabuong LaTeX na dokumento ay
naka-save sa file ocamldoc.out, o sa file na tinukoy kasama ng -o pagpipilian.

-lalaki Bumuo ng dokumentasyon bilang isang set ng Unix man page. Ang mga nabuong pahina ay iniimbak
sa kasalukuyang direktoryo, o sa direktoryong tinukoy kasama ng -d pagpipilian.

-tuldok Bumuo ng dependency graph para sa mga toplevel na module, sa isang format na angkop para sa
pagpapakita at pagproseso ng tuldok(1). Ang tuldok(1) magagamit ang tool mula sa
http://www.research.att.com/sw/tools/graphviz/. Ang representasyong tekstwal ng
graph ay nakasulat sa file ocamldoc.out, o sa file na tinukoy sa -o
pagpipilian Gamitin tuldok ocamldoc.out upang ipakita ito.

-g file
Dynamic na i-load ang ibinigay na file (na karaniwang extension ay .cmo o .cma), na
tumutukoy sa isang custom na dokumentasyon generator. Kung ang ibinigay na file ay isang simple at
ay hindi umiiral sa kasalukuyang direktoryo, kung gayon ocamldoc hinahanap ito sa kaugalian
generators default na direktoryo, at sa mga direktoryo na tinukoy sa -i pagpipilian.

-customdir
Ipakita ang default na direktoryo ng mga pasadyang generator.

-i direktoryo
Idagdag ang ibinigay na direktoryo sa landas kung saan hahanapin ang mga custom na generator.

Pangkalahatan pagpipilian
-d dir Bumuo ng mga file sa direktoryo dir, sa halip na ang kasalukuyang direktoryo.

-tapon file
Itapon ang nakolektang impormasyon sa file. Ang impormasyong ito ay mababasa gamit ang -load
opsyon sa isang kasunod na panawagan ng ocamldocNa (1).

-tago module
Itago ang ibinigay na kumpletong mga pangalan ng module sa nabuong dokumentasyon. module ay isang
Ang listahan ng mga kumpletong pangalan ng module ay pinaghihiwalay ng mga kuwit (,), nang walang mga blangko. Para sa
halimbawa: Pervasives,M2.M3.

-inv-merge-ml-mli
Baligtarin ang pangunguna ng mga pagpapatupad at interface kapag pinagsasama. Lahat
Ang mga elemento sa mga file ng pagpapatupad ay pinananatili, at ang -m ang opsyon ay nagpapahiwatig kung aling mga bahagi
ng mga komento sa mga file ng interface ay pinagsama sa mga komento sa pagpapatupad
file.

-keep-code
Palaging panatilihin ang source code para sa mga halaga, pamamaraan at mga variable ng instance, kung kailan
magagamit. Ang source code ay palaging pinapanatili kapag ang isang .ml file ay ibinigay, ngunit sa pamamagitan ng
default na itinapon kapag ibinigay ang isang .mli. Ang pagpipiliang ito ay nagpapahintulot sa source code na maging
laging iniingatan.

-load file
Mag-load ng impormasyon mula sa file, na ginawa ng ocamldoc -tapon. Marami
-load maaaring ibigay ang mga pagpipilian.

-m flag
Tukuyin ang mga opsyon sa pagsasanib sa pagitan ng mga interface at pagpapatupad. flag maaaring isa o
ilan sa mga sumusunod na karakter:

d pagsasanib ng paglalarawan

a pagsamahin ang @may-akda

v pagsamahin ang @bersyon

l pagsamahin ang @see

s pagsamahin ang @mula

o pagsamahin ang @deprecated

p pagsamahin ang @param

e pagsamahin ang @raise

r pagsamahin ang @pagbabalik

A pagsamahin ang lahat

-walang-custom-tag
Huwag payagan ang mga custom na @-tag.

-walang tigil
Panatilihin ang mga elemento na nakalagay pagkatapos ng (**/**) espesyal na komento.

-o file
I-output ang nabuong dokumentasyon sa file sa halip ng ocamldoc.out. Ang pagpipiliang ito ay
makabuluhan lamang kasabay ng -latex, -texi, O -tuldok mga pagpipilian.

-pp utos
Mga mapagkukunan ng tubo sa pamamagitan ng preprocessor utos.

-ppx utos
Pipe abstract syntax tree sa pamamagitan ng preprocessor utos.

-uri-uriin Pagbukud-bukurin ang listahan ng mga top-level na module bago bumuo ng dokumentasyon.

-mga bituin Alisin ang mga blangkong character hanggang sa unang asterisk ('*') sa bawat linya ng mga komento.

-t pamagat
paggamit pamagat bilang pamagat para sa nabuong dokumentasyon.

-intro file
Gumamit ng nilalaman ng file as ocamldoc tekstong gagamitin bilang panimula (HTML, LaTeX at
TeXinfo lamang). Para sa HTML, ang file ay ginagamit upang gawin ang buong "index.html" na file.

-v Verbose mode. Ipakita ang impormasyon sa pag-unlad.

-version
I-print ang string ng bersyon at lumabas.

-vnum I-print ang maikling numero ng bersyon at lumabas.

-babala-error
Gamutin ocamldoc mga babala bilang mga pagkakamali.

-itago-babala
Huwag mag-print ocamldoc mga babala

-tulong or - Tumulong
Magpakita ng maikling buod ng paggamit at paglabas.

Pagsusuri ng uri pagpipilian
ocamldoc(1) tumatawag sa OCaml type-checker upang makakuha ng impormasyon ng uri. Ang mga sumusunod na opsyon
makakaapekto sa yugto ng pagsuri ng uri. Ang mga ito ay may parehong kahulugan bilang para sa
ocamlc(1) at ocamlopt(1) mga utos.

-I direktoryo
Idagdag direktoryo sa listahan ng mga direktoryo, maghanap ng pinagsama-samang mga file ng interface (.cmi
mga file).

-nolabels
Huwag pansinin ang mga hindi opsyonal na label sa mga uri.

-recttypes
Payagan ang mga arbitrary na recursive na uri. (Tingnan ang -recttypes pagpipilian sa ocamlc(1).)

Options para generating HTML mga pahina
Ang mga sumusunod na opsyon ay nalalapat kasabay ng -html opsiyon:

-lahat-params
Ipakita ang kumpletong listahan ng mga parameter para sa mga function at pamamaraan.

-css-style filename
paggamit filename bilang ang Cascading Style Sheet file.

-kulay-code
Kulayan ang OCaml code na nakapaloob sa [ ] at \{[ ]\}, gamit ang mga kulay upang bigyang-diin
mga keyword, atbp. Kung ang mga fragment ng code ay hindi syntactically tama, walang kulay
idinagdag.

-index-lamang
Bumuo lamang ng mga index na file.

-short-functors
Gumamit ng maikling form upang ipakita ang mga function: module M : functor (A:Modyul) -> functor
(B:Modyul2) -> sig .. dulo ay ipinapakita bilang module M (A:Modyul) (B:Modyul2) : sig ..
dulo.

Options para generating LaTeX file
Ang mga sumusunod na opsyon ay nalalapat kasabay ng -latex opsiyon:

-latex-value-prefix unlapi
Magbigay ng prefix na gagamitin para sa mga label ng mga value sa nabuong LaTeX na dokumento.
Ang default na prefix ay ang walang laman na string. Maaari mo ring gamitin ang mga pagpipilian -uri ng latex-
unlapi, -latex-exception-prefix, -latex-module-prefix, -latex-module-type-prefix,
-latex-class-prefix, -latex-class-type-prefix, -latex-attribute-prefix, at -latex-
paraan-prefix.

Ang mga opsyon na ito ay kapaki-pakinabang kapag mayroon kang, halimbawa, isang uri at isang halaga na may
parehong pangalan. Kung hindi ka tumukoy ng mga prefix, magrereklamo ang LaTeX tungkol sa multiply
tinukoy na mga label.

-latextitle n, istilo
Iugnay ang numero ng istilo n sa ibinigay na LaTeX sectioning command estilo, halimbawa
seksyonorsubsection. (LaTeX lang.) Ito ay kapaki-pakinabang kapag kasama ang nabuo
dokumento sa isa pang LaTeX na dokumento, sa isang partikular na antas ng sectioning. Ang default
asosasyon ay 1 para sa seksyon, 2 para sa subsection, 3 para sa subsubsection, 4 para sa
talata at 5 para sa subparagraph.

-noheader
Pigilan ang header sa nabuong dokumentasyon.

-notoc Huwag bumuo ng talaan ng mga nilalaman.

-notrailer
Pigilan ang trailer sa nabuong dokumentasyon.

-sepfiles
Bumuo ng isang .tex file sa bawat toplevel na module, sa halip na ang global ocamldoc.out
file.

Options para generating TeXinfo file
Ang mga sumusunod na opsyon ay nalalapat kasabay ng -texi opsiyon:

-esc8 Takasan ang mga may accent na character sa mga file ng Impormasyon.

-pagpasok ng impormasyon
Tukuyin ang entry sa direktoryo ng Impormasyon.

-info-section
Tukuyin ang seksyon ng Direktoryo ng Impormasyon.

-noheader
Pigilan ang header sa nabuong dokumentasyon.

-noindex
Huwag bumuo ng index para sa mga file ng Impormasyon.

-notrailer
Pigilan ang trailer sa nabuong dokumentasyon.

Options para generating tuldok graph
Ang mga sumusunod na opsyon ay nalalapat kasabay ng -tuldok opsiyon:

-mga tuldok-kulay kulay
Tukuyin ang mga kulay na gagamitin sa nabuong dot code. Kapag bumubuo ng module
dependencies, ocamldoc(1) gumagamit ng iba't ibang kulay para sa mga module, depende sa
mga direktoryo kung saan sila nakatira. Kapag bumubuo ng mga dependency ng mga uri, ocamldoc(1)
gumagamit ng iba't ibang kulay para sa mga uri, depende sa mga module kung nasaan ang mga ito
tinukoy. kulay ay isang listahan ng mga pangalan ng kulay na pinaghihiwalay ng mga kuwit (,), tulad ng sa
Red, Blue, Green. Ang mga magagamit na kulay ay ang mga sinusuportahan ng tuldok(1) kasangkapan.

-tuldok-isama-lahat
Isama ang lahat ng mga module sa tuldok(1) output, hindi lamang mga module na ibinigay sa command
linya o puno ng mga -load pagpipilian.

-tuldok-bawasan
Magsagawa ng transitive reduction ng dependency graph bago i-output ang tuldok
code. Ito ay maaaring maging kapaki-pakinabang kung mayroong maraming mga transitive dependencies na kalat
ang graph.

-mga uri ng tuldok
Output dot code na naglalarawan sa uri ng dependency graph sa halip na ang module
graph ng dependency.

Options para generating lalaki file
Ang mga sumusunod na opsyon ay nalalapat kasabay ng -lalaki opsiyon:

-lalaking-mini
Bumuo ng mga man page para lang sa mga module, uri ng module, klase at uri ng klase, sa halip
ng mga pahina para sa lahat ng elemento.

-tao-panlapi suffix
Itakda ang suffix na ginamit para sa mga nabuong man filename. Ang default ay o, tulad ng sa Listahan.o.

-man-section seksyon
Itakda ang numero ng seksyon na ginamit para sa mga nabuong man filename. Ang default ay 3.

Gumamit ng ocamldoc online gamit ang mga serbisyo ng onworks.net