Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
branch: master
..
Failed to load latest commit information.
HtmlAgilityPack EOL handling
deploy Create .gitignore's.
sources Remove MONO_API from some internal GC APIs.
svgs The drawings for the /Compacting_GC page
.gitignore Add a few .gitignore entries to reduce noise
ChangeLog * docs/Makefile.am: fix distcheck - several targets get built on the
Makefile.am Fix "make dist"
README Switch from using HtmlAgilityPack 1.0 binary snapshot to HtmlAgilityP…
TODO * Makefile.am: Build `docs` after `runtime`, so that it can depend
abc-removal.txt Make docs consistent
api-style.css * Makefile.am: Build `docs` after `runtime`, so that it can depend
check-coverage * Makefile.am: Build `docs` after `runtime`, so that it can depend
check-exports * check, Makefile.am (EXTRA_DIST): Rename to check-exports. This was
convert.cs * Makefile.am: Build `docs` after `runtime`, so that it can depend
current-api Remove MONO_API from some internal GC APIs.
docs.make Runtime documentation will now build with srcdir != builddir
documented Remove MONO_API from some internal GC APIs.
embedded-api Add notice
exceptions Remove outdated documentation from the docs subdirectory.
exdoc Runtime documentation will now build with srcdir != builddir
file-share-modes File share mode notes
gc-issues Added the docs dir to the dist (with a new doc on GC issues).
gc-variables-in-c Precise GC doc updates.
glossary.txt Add
historic-mono-branches.txt Add a list of historic Mono branches, before we delete them from the …
ignore Update documentation to latest changes, need to document a lot of mis…
internal-calls Documentation updates.
ir-desc Doc update
jit-imt Primarily, add support for mono_arch_get_throw_corlib_exception and IMT
jit-thoughts *** empty log message ***
jit-trampolines Update
magic.diff magic file(1) patch.
mini-doc.txt Update docs
mono-api-metadata.html * Makefile.am: Build `docs` after `runtime`, so that it can depend
mono-file-formats.config * docs.make, Makefile.am: Build mono-file-formats{.tree,.zip},
mono-file-formats.source * mono-file-formats.source, mono-tools.source: Place these under the
mono-tools.config remove monostyle manpage
mono-tools.source * mono-file-formats.source, mono-tools.source: Place these under the
monoapi.source * Makefile.am: Build `docs` after `runtime`, so that it can depend
object-layout documentation updates
precise-gc Precise GC doc updates.
produce-lists Remove methods that are private from the documentation
public * Makefile.am: Build `docs` after `runtime`, so that it can depend
public-api Remove MONO_API from some internal GC APIs.
remoting Added information about the cross-app domain optimizations in the rem…
ssapre.txt Corrected word spelling
stack-overflow.txt Add
threading Thread doc
toc.xml [runtime/docs] Update toc
unmanaged-calls documentation updates
wapi Update documentation to latest changes, need to document a lot of mis…

README

Documentation is now maintained on the mono wiki:

http://www.mono-project.com/Mono:Runtime:Documentation

Older documents or documents which were not yet migrated to the wiki are kept here.

* 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 the 
        HtmlAgilityPack folder, and are a prerequisite for convert.exe.

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.

Something went wrong with that request. Please try again.