diff options
author | Miguel de Icaza <miguel@gnome.org> | 2016-02-03 18:11:19 +0300 |
---|---|---|
committer | Miguel de Icaza <miguel@gnome.org> | 2016-02-03 18:11:19 +0300 |
commit | b8462def3cff0b121cd9cbcf40fe11cc80fe2100 (patch) | |
tree | 4f12650f3ffaa25621c266ae5ae7f5274354b025 /docs | |
parent | e0ac73928fdbb843b6ff77a428dca91bbb397fc0 (diff) |
[Documentation] Document some of Mono's embedding API, improve the style
Diffstat (limited to 'docs')
-rw-r--r-- | docs/exdoc | 31 | ||||
-rw-r--r-- | docs/sources/mono-api-class.html | 24 |
2 files changed, 42 insertions, 13 deletions
diff --git a/docs/exdoc b/docs/exdoc index f2711d26b13..4e60e1b90c7 100644 --- a/docs/exdoc +++ b/docs/exdoc @@ -58,26 +58,28 @@ if ($html){ } .api { - border: 1px solid; padding: 10pt; margin: 10pt; } .api-entry { border-bottom: none; - font-size: 18px; + font-size: 120%; } .prototype { - border: 1px solid; - background-color: #f2f2f2; - padding: 5pt; + border: 3px solid #ecf0f1; + border-radius: 6px; + padding: 1em 1.2em; margin-top: 5pt; - margin-bottom: 5pt; + margin-bottom: 5pt; + font-family: "Consolas", "Courier", monospace; + display: block; + overflow: auto; } .header { - border: 1px solid; + padding: 0 0 5pt 5pt; margin: 10pt; white-space: pre; @@ -104,6 +106,9 @@ EOF if ($api ne ""){ if ($api_shown == 1){ print OUT "</div>"; + if ($deprecated{$api}){ + print OUT "<p><b>DEPRECATED ${deprecated{$api}}</b>"; + } } $api_shown = 1; $proto = $prototype{$api}; @@ -121,7 +126,7 @@ print OUT<<EOF; EOF &opt_print ("Parameters", $arguments{$api}, 1); &opt_print ("Returns", $returns{$api}, 1); - &opt_print ("Remarks", $bodies{$api}, 0); + &opt_print ("Description", $bodies{$api}, 0); print OUT "\n"; } else { if ($line =~ /@API_IDX@/){ @@ -168,7 +173,8 @@ sub process_doc { $returns = ""; $body = ""; $functions[$fn++] = $func; - + $deprecated = 0; + # Process arguments while (<>){ if (/^ \*\*?\//){ @@ -179,6 +185,7 @@ sub process_doc { $body =~ s/\n/ /; $bodies{$func} = $body; $arguments{$func} = $args; + $deprecated{$func} = $deprecated; $returns{$func} = $returns; $proto = ""; while (<>){ @@ -199,7 +206,11 @@ sub process_doc { if ($inbody == 0){ if (/\s*(\w+):(.*)/){ - $args .= "<dt><i>$1:</i></dt><dd>$2</dd>"; + if ($1 eq "deprecated"){ + $deprecated = $2; + } else { + $args .= "<dt><i>$1:</i></dt><dd>$2</dd>"; + } } else { $body = "\t$_\n"; diff --git a/docs/sources/mono-api-class.html b/docs/sources/mono-api-class.html index f1c92dff1ae..328761577b8 100644 --- a/docs/sources/mono-api-class.html +++ b/docs/sources/mono-api-class.html @@ -1,15 +1,33 @@ - <h2>Class Operations</h2> + <p>The operations on <code>MonoClass*</code> allow you to + query a number of properties of a .NET class from the C API. + <h3>Getting a MonoClass</h3> -<h4><a name="api:mono_class_from_generic_parameter">mono_class_from_generic_parameter</a></h4> + <p>You typically would obtain a <code>MonoClass*</code> + pointer by using a combination of the <code>MonoImage*</code> + where the type is located, the namespace and name using the + <code><a href="api:mono_class_from_name">mono_class_from_name</a></code> + or + the <code><a href="api:mono_class_from_name_case">mono_class_from_name_case</a></code> + APIs or by using + the <code><a href="api:mono_class_from_typeref">mono_class_from_typeref</a></code> + or <code><a href="api:mono_class_from_typeref">mono_class_from_typeref_checked</a></code> + methods. + + <p>For low-level access, you can get the <code>MonoClass + *</code> from an image and an ECMA type token relative to + the <code>MonoImage*</code> by using <a href="api:mono_class_get">mono_class_get</a></h4>. + + +<h4><a name="api:mono_class_get">mono_class_get</a></h4> <h4><a name="api:mono_class_from_mono_type">mono_class_from_mono_type</a></h4> <h4><a name="api:mono_class_from_name">mono_class_from_name</a></h4> <h4><a name="api:mono_class_from_name_case">mono_class_from_name_case</a></h4> <h4><a name="api:mono_class_from_typeref">mono_class_from_typeref</a></h4> <h4><a name="api:mono_class_from_typeref_checked">mono_class_from_typeref_checked</a> -<h4><a name="api:mono_class_get">mono_class_get</a></h4> +<h4><a name="api:mono_class_from_generic_parameter">mono_class_from_generic_parameter</a></h4> <h3>Working with a MonoClass</h3> |