diff options
author | Miguel de Icaza <miguel@gnome.org> | 2016-02-09 19:46:46 +0300 |
---|---|---|
committer | Miguel de Icaza <miguel@gnome.org> | 2016-02-09 19:46:46 +0300 |
commit | 81b702280051c5439e676debbf43ca89c5e63e9c (patch) | |
tree | 62f4eca639566200582134d52dade4e0f2c59a88 /docs | |
parent | 3cdd142b666f963ffcef297d8de023fa2bb33079 (diff) |
[Docs] Improved the rendering, added some docs
Diffstat (limited to 'docs')
-rw-r--r-- | docs/exdoc | 13 | ||||
-rw-r--r-- | docs/sources/mono-api-assembly.html | 32 | ||||
-rw-r--r-- | docs/sources/mono-api-class.html | 10 | ||||
-rw-r--r-- | docs/sources/mono-api-embedding.html | 13 | ||||
-rw-r--r-- | docs/toc.xml | 36 |
5 files changed, 74 insertions, 30 deletions
diff --git a/docs/exdoc b/docs/exdoc index 7ce4b9290cc..058a2f7b962 100644 --- a/docs/exdoc +++ b/docs/exdoc @@ -63,6 +63,7 @@ $css EOF @a = split (/\n/, $files_content[$f]); $strikeextra = ""; + $api_shown = 0; for ($ai = 0; $ai < $#a; $ai++){ $line = $a[$ai]; @@ -134,14 +135,16 @@ EOF open HACKOUT, ">$dir/deploy/$name" || die "Could not open output"; $line = 0; + $doprint = 0; while (<HACK>){ + print HACKOUT $last if ($doprint); $line++; s/^\/\/<!\[CDATA\[//; s/^\/\/\]\]>\/\///; # Remove the junk <span> wrapper generated by AgilityPack if ($line==1){ - s/<?span>//; + s/<span>//; } if (/<style type/){ # Replace the CSS in the XHTML output with the original CSS @@ -151,9 +154,13 @@ EOF last if (/<\/style>/); } } - - print HACKOUT $_; + $last = $_; + $doprint = 1; + } + if (!($last =~ /span/)){ + print HACKOUT $last; } + #system ("cp.exe $dir/html/$name $dir/deploy/$name"); } } diff --git a/docs/sources/mono-api-assembly.html b/docs/sources/mono-api-assembly.html index 979a74c5246..0f46f26805c 100644 --- a/docs/sources/mono-api-assembly.html +++ b/docs/sources/mono-api-assembly.html @@ -1,5 +1,28 @@ <h2>Assemblies</h2> + <p>Code in .NET and Mono is distributed in assemblies, there + are shipped typically in files with the extension .exe or + .dll, and they are files that extend + the <a href="https://en.wikipedia.org/wiki/Portable_Executable">Portable + Executable</a> file format to include the Common Intermediate + Language metadata and portable code. + + <p>Assemblies are typically loaded either from a given file + path, or using an <a href="#assembly-name">Assembly Name</a> + to load them from the Global Assembly Cache. + + <p>The Mono Assembly API contains method for dealing with + <a href="#assembly-name">assembly + names</a>, <a href="cil_assembly_load">loading assemblies</a>, + <a href="#working">accessing assembly + components</a>, <a href="#modules">modules</a> and + some <a href="#advanced">advanced</a> features. + + <p>Assemblies contain one or + more images, the actual vessels for your code. + The <a href="mono-api-image.html">Image API</a> documents the + functions that operate on <code>MonoImage *</code>. + <h3>Synopsis</h3> <div class="mapi-header"> @@ -7,12 +30,9 @@ typedef struct _MonoImage MonoImage; typedef struct _MonoAssembly MonoAssembly; - -@API_IDX@ - </div> -<a name="cil_assembly_load"/> +<a name="cil_assembly_load"/></a> <h3>Assembly Loading</h3> <h4><a name="api:mono_assembly_close">mono_assembly_close</a></h4> @@ -28,6 +48,7 @@ typedef struct _MonoAssembly MonoAssembly; <h4><a name="api:mono_set_assemblies_path">mono_set_assemblies_path</a></h4> <h4><a name="api:mono_set_rootdir">mono_set_rootdir</a></h4> +<a name="working"/> <h3>Working with Assemblies</h3> <h4><a name="api:mono_assembly_fill_assembly_name">mono_assembly_fill_assembly_name</a></h4> @@ -48,6 +69,7 @@ typedef struct _MonoAssembly MonoAssembly; <h4><a name="api:mono_register_config_for_assembly">mono_register_config_for_assembly</a></h4> <h4><a name="api:mono_register_symfile_for_assembly">mono_register_symfile_for_assembly</a></h4> +<a name="assembly-name"></a> <h3>Assembly Names</h3> <p>The MonoAssemblyName contains the full identity of an @@ -67,6 +89,7 @@ typedef struct _MonoAssembly MonoAssembly; <h4><a name="api:mono_stringify_assembly_name">mono_stringify_assembly_name</a></h4> <h4><a name="api:mono_assembly_names_equal">mono_assembly_names_equal</a></h4> +<a href="modules"/> <h3>Modules</h3> <p>An assembly is made up of one or more modules. @@ -75,6 +98,7 @@ typedef struct _MonoAssembly MonoAssembly; <h4><a name="api:mono_module_get_object">mono_module_get_object</a></h4> +<a href="advanced"/> <h3>Advanced</h3> <h4><a name="api:mono_install_assembly_load_hook">mono_install_assembly_load_hook</a></h4> diff --git a/docs/sources/mono-api-class.html b/docs/sources/mono-api-class.html index a15720635d8..fddded790f4 100644 --- a/docs/sources/mono-api-class.html +++ b/docs/sources/mono-api-class.html @@ -4,15 +4,15 @@ query a number of properties of a .NET class from the C API. <p>This page contains information - for <a href="#class-getting">how to obtain a MonoClass</a>, + for <a href="#class-getting">how to obtain a MonoClass*</a>, how to <a href="#class-work">probe for different - features of a UonoClass</a> and APIs + features of a MonoClass*</a> and APIs to <a href="#class-members">access class members</a> and <a href="#class-fields">access fields</a>. To access methods, see the <a href="mono-api-methods.html">method documentation API</a>. -<a name="class-getting"> +<a name="class-getting"></a> <h3>Getting a MonoClass</h3> <p>You typically would obtain a <code>MonoClass*</code> @@ -80,7 +80,7 @@ <h4><a name="api:mono_class_value_size">mono_class_value_size</a></h4> <h4><a name="api:mono_class_vtable">mono_class_vtable</a></h4> -<a name="class-members"> +<a name="class-members"></a> <h3>Getting Class Members</h3> <h4><a name="api:mono_class_get_fields">mono_class_get_fields</a></h4> @@ -93,7 +93,7 @@ <h4><a name="api:mono_class_get_property_from_name">mono_class_get_property_from_name</a></h4> <h4><a name="api:mono_class_get_events">mono_class_get_events</a></h4> -<a name="class-fields"> +<a name="class-fields"></a> <h3>Fields</h3> <h4><a name="api:mono_field_get_data">mono_field_get_data</a></h4> diff --git a/docs/sources/mono-api-embedding.html b/docs/sources/mono-api-embedding.html index 4c4329f634a..fe086b29d91 100644 --- a/docs/sources/mono-api-embedding.html +++ b/docs/sources/mono-api-embedding.html @@ -1,5 +1,18 @@ <h2>Embedding Mono</h2> + <p>The Mono runtime can be embedded into C and C++ + applications. Your C/C++ code can invoke managed code + running in the Mono/.NET world and you can also surface your + internal application APIs to Mono and .NET. + + <p>For an overview of how to embed Mono into your application + and the strategies that you can use to embed Mono, check the + Mono + website's <a href="http://www.mono-project.com/docs/advanced/embedding/">Embedding + Mono</a> page. + + <p>This page is the companion API reference for the above guide. + <p>The simplest way of embedding Mono is illustrated here: <pre> int main (int argc, char *argv) diff --git a/docs/toc.xml b/docs/toc.xml index 656dd26ba08..5641273c09e 100644 --- a/docs/toc.xml +++ b/docs/toc.xml @@ -14,6 +14,12 @@ </li> <li> <object type="text/sitemap"> + <param name="Name" value="Embedding Mono"/> + <param name="Local" value="deploy/mono-api-embedding.html"/> + </object> + </li> + <li> + <object type="text/sitemap"> <param name="Name" value="Assemblies"/> <param name="Local" value="deploy/mono-api-assembly.html"/> </object> @@ -56,12 +62,6 @@ </li> <li> <object type="text/sitemap"> - <param name="Name" value="Dynamic Code Generation"/> - <param name="Local" value="deploy/mono-api-dynamic-codegen.html"/> - </object> - </li> - <li> - <object type="text/sitemap"> <param name="Name" value="Exceptions"/> <param name="Local" value="deploy/mono-api-exc.html"/> </object> @@ -80,12 +80,6 @@ </li> <li> <object type="text/sitemap"> - <param name="Name" value="Embedding Mono"/> - <param name="Local" value="deploy/mono-api-embedding.html"/> - </object> - </li> - <li> - <object type="text/sitemap"> <param name="Name" value="Just in Time Compiler"/> <param name="Local" value="deploy/mono-api-jit.html"/> </object> @@ -124,12 +118,6 @@ --> <li> <object type="text/sitemap"> - <param name="Name" value="JIT Counters"/> - <param name="Local" value="deploy/mono-api-counters.html"/> - </object> - </li> - <li> - <object type="text/sitemap"> <param name="Name" value="Types"/> <param name="Local" value="deploy/mono-api-type.html"/> </object> @@ -166,10 +154,22 @@ </li> <li> <object type="text/sitemap"> + <param name="Name" value="JIT Counters"/> + <param name="Local" value="deploy/mono-api-counters.html"/> + </object> + </li> + <li> + <object type="text/sitemap"> <param name="Name" value="Unsorted"/> <param name="Local" value="deploy/mono-api-unsorted.html"/> </object> </li> + <li> + <object type="text/sitemap"> + <param name="Name" value="Internal: Dynamic Code Generation"/> + <param name="Local" value="deploy/mono-api-dynamic-codegen.html"/> + </object> + </li> </ul> </body> </html> |