Skip to content
Find file History
Latest commit aeccd22 Apr 4, 2016 @marek-safar marek-safar [build] Change the way how mcs references are passed to compiler to a…
…lways use full path.

One of csc prerequisites because csc uses -lib as path which is considered after
RuntimeEnvironment.GetRuntimeDirectory which makes -lib useless
..
Failed to load latest commit information.
HtmlAgilityPack EOL handling Jul 25, 2010
deploy Create .gitignore's. Feb 28, 2009
sources [Docs] Continue to improve the Mono runtime documentation Feb 9, 2016
svgs The drawings for the /Compacting_GC page Jun 5, 2006
.gitignore Add a few .gitignore entries to reduce noise Jul 28, 2010
Makefile.am [docs] remove a deleted file from EXTRA_DIST Feb 3, 2016
README Switch from using HtmlAgilityPack 1.0 binary snapshot to HtmlAgilityP… Dec 22, 2009
TODO * Makefile.am: Build `docs` after `runtime`, so that it can depend Oct 31, 2008
abc-removal.txt Make docs consistent Apr 21, 2007
api-style.css [Docs] Continue to improve the Mono runtime documentation Feb 9, 2016
check-coverage * Makefile.am: Build `docs` after `runtime`, so that it can depend Oct 31, 2008
check-exports * check, Makefile.am (EXTRA_DIST): Rename to check-exports. This was Oct 31, 2008
convert.cs * Makefile.am: Build `docs` after `runtime`, so that it can depend Oct 31, 2008
docs.make [build] Change the way how mcs references are passed to compiler to a… Apr 4, 2016
embedded-api Add notice Jun 5, 2006
exceptions Remove outdated documentation from the docs subdirectory. Apr 7, 2015
exdoc [Docs] handle code-markdown with dots on the names Feb 9, 2016
file-share-modes File share mode notes May 21, 2004
gc-issues Added the docs dir to the dist (with a new doc on GC issues). Mar 29, 2002
gc-variables-in-c Precise GC doc updates. May 30, 2006
glossary.txt Add Jun 24, 2007
historic-mono-branches.txt Add a list of historic Mono branches, before we delete them from the … Aug 4, 2011
ignore Update documentation to latest changes, need to document a lot of mis… May 11, 2010
internal-calls Documentation updates. Sep 25, 2006
ir-desc Doc update Sep 6, 2004
jit-imt Primarily, add support for mono_arch_get_throw_corlib_exception and IMT Mar 23, 2010
jit-thoughts *** empty log message *** May 11, 2002
jit-trampolines Update Aug 19, 2008
magic.diff magic file(1) patch. Mar 24, 2006
mini-doc.txt Update docs May 26, 2010
mono-api-metadata.html * Makefile.am: Build `docs` after `runtime`, so that it can depend Oct 31, 2008
mono-file-formats.config * docs.make, Makefile.am: Build mono-file-formats{.tree,.zip}, Nov 19, 2008
mono-file-formats.source * mono-file-formats.source, mono-tools.source: Place these under the Dec 8, 2008
mono-tools.config remove monostyle manpage Nov 10, 2009
mono-tools.source * mono-file-formats.source, mono-tools.source: Place these under the Dec 8, 2008
monoapi.source * Makefile.am: Build `docs` after `runtime`, so that it can depend Oct 31, 2008
object-layout documentation updates Mar 15, 2002
precise-gc Precise GC doc updates. May 30, 2006
produce-lists Remove methods that are private from the documentation May 11, 2010
remoting Added information about the cross-app domain optimizations in the rem… Nov 10, 2004
ssapre.txt Corrected word spelling Aug 10, 2011
stack-overflow.txt Add Sep 12, 2007
threading Thread doc Mar 7, 2003
toc.xml [Docs] Improved the rendering, added some docs Feb 9, 2016
unmanaged-calls documentation updates Mar 15, 2002
wapi Update documentation to latest changes, need to document a lot of mis… May 11, 2010

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.