docs/README

   1 Documentation is now maintained on the mono wiki:
   2
   3 http://www.mono-project.com/Mono:Runtime:Documentation
   4
   5 Older documents or documents which were not yet migrated to the wiki are kept here.
   6
   7 * Scripts to maintain the Mono VM internal API
   8
   9 Layout
  10 ------
  11
  12         sources/
  13                 mono-api-*.html
  14
  15                 Contains the various source files, each source file
  16                 contains HTML, and a line for each API call like this:
  17
  18                 <h4><a name="api:mono_something">mono_something</a></h4>
  19
  20                 The format is static, notice that the tools actually search
  21                 for the above format and process that (both the tools here,
  22                 as well as the upcoming Monodoc tools and index creation
  23                 tools).
  24
  25                 The files can contain any ammount of extra information.
  26
  27                 The documentation from the source code is then merged with
  28                 these files and the header/footer information to produce
  29                 the deploy directory.
  30
  31         deploy/
  32
  33                 Scripts produce a ready-to-use set of XHTML files that can
  34                 be either fed into a monodoc XHTML provider or can be published
  35                 directly on the web.
  36
  37 PROGRAMS
  38 --------
  39 * check-coverage
  40
  41         Run this script every once in a while to make sure that a
  42         public symbol that has been added to Mono has a corresponding
  43         section on the mono-vm-api.html
  44
  45         This works by looking for the <h4>APICALL</h4> pattern on the
  46         HTML file.
  47
  48 * produce-lists
  49
  50         Produces the public-api and wapi files that contain the public
  51         libmono API.
  52
  53 * exdoc
  54
  55         Extracts the embedded documentation from the sources.
  56
  57 * check
  58
  59         This script is used to verify which routines are missing inline
  60         documentation, usage:
  61
  62                 check mono/metadata/*.c
  63
  64 * convert.cs
  65
  66         Converts an HTML file into a valid XML document, uses the
  67         AgilityPack.dll.  The sources to this DLL live in the
  68         HtmlAgilityPack folder, and are a prerequisite for convert.exe.
  69
  70 DATAFILES:
  71 ---------
  72
  73         ignore
  74
  75                 Contains the list of public symbols that should be
  76                 ignored, they come from tests for example, or are known
  77                 to be exposed.
  78
  79                 This is consumed by produce-lists
  80
  81         public-api
  82         wapi
  83                 These two are produced by the produce-lists script
  84                 and it documents all the public methods.
  85