mirror of
https://github.com/BepInEx/mono.git
synced 2026-11-17 11:21:39 -10:00
upon mdoc.exe for it's operation. * docs/. (svn:ignore), deploy (svn:ignore): Ignore generated files. * docs/AgilityPack.dll, docs/api-style.css, docs/ChangeLog, docs/check, docs/check-coverage, docs/convert.cs, docs/current-api, docs/deploy, docs/documented, docs/exdoc, docs/ignore, docs/mono-api-metadata.html, docs/monoapi.source, docs/produce-lists, docs/public, docs/public-api, docs/README, docs/sources, docs/toc.xml, docs/TODO, docs/wapi: Copy from ../mono/docscripts. * docs/exdoc: Use the in-tree mono program to run convert.exe. * docs/Makefile.am: Mention files to clean/distribute; extract documentation (with exdoc) and then assemble documentation (with monoapi.make's assemble target) for use by monodoc. * docs/monoapi.make: Added; Makefile to use mcs' buid/rules.make to compile convert.cs and assemble documentation. (This is a separate file so that we can include mcs' build/rules.make, which needs topdir set to behave properly BUT must be $(mcs_topdir) from Makefile.am's perspective.) * docs/monoapi.source: Add a /monodoc/node element for use with monodoc 2.2. svn path=/trunk/mono/; revision=117529
82 lines
1.9 KiB
Plaintext
82 lines
1.9 KiB
Plaintext
* Scripts to maintain the Mono VM internal API
|
|
|
|
Layout
|
|
------
|
|
|
|
sources/
|
|
mono-api-*.html
|
|
|
|
Contains the various source files, each source file
|
|
contains HTML, and a line for each API call like this:
|
|
|
|
<h4><a name="api:mono_something">mono_something</a></h4>
|
|
|
|
The format is static, notice that the tools actually search
|
|
for the above format and process that (both the tools here,
|
|
as well as the upcoming Monodoc tools and index creation
|
|
tools).
|
|
|
|
The files can contain any ammount of extra information.
|
|
|
|
The documentation from the source code is then merged with
|
|
these files and the header/footer information to produce
|
|
the deploy directory.
|
|
|
|
deploy/
|
|
|
|
Scripts produce a ready-to-use set of XHTML files that can
|
|
be either fed into a monodoc XHTML provider or can be published
|
|
directly on the web.
|
|
|
|
PROGRAMS
|
|
--------
|
|
* check-coverage
|
|
|
|
Run this script every once in a while to make sure that a
|
|
public symbol that has been added to Mono has a corresponding
|
|
section on the mono-vm-api.html
|
|
|
|
This works by looking for the <h4>APICALL</h4> pattern on the
|
|
HTML file.
|
|
|
|
* produce-lists
|
|
|
|
Produces the public-api and wapi files that contain the public
|
|
libmono API.
|
|
|
|
* exdoc
|
|
|
|
Extracts the embedded documentation from the sources.
|
|
|
|
* check
|
|
|
|
This script is used to verify which routines are missing inline
|
|
documentation, usage:
|
|
|
|
check mono/metadata/*.c
|
|
|
|
* convert.cs
|
|
|
|
Converts an HTML file into a valid XML document, uses the
|
|
AgilityPack.dll. The sources to this DLL live in GNOME CVS
|
|
module beagle/Filters/AgilityPack.
|
|
|
|
A binary is shipped for our convenience.
|
|
|
|
DATAFILES:
|
|
---------
|
|
|
|
ignore
|
|
|
|
Contains the list of public symbols that should be
|
|
ignored, they come from tests for example, or are known
|
|
to be exposed.
|
|
|
|
This is consumed by produce-lists
|
|
|
|
public-api
|
|
wapi
|
|
These two are produced by the produce-lists script
|
|
and it documents all the public methods.
|
|
|