diff options
author | Miguel de Icaza <miguel@gnome.org> | 2016-02-08 21:56:51 +0300 |
---|---|---|
committer | Miguel de Icaza <miguel@gnome.org> | 2016-02-08 23:02:07 +0300 |
commit | 7d5a7ea7ac324bb4ee63094ddcf8e20ae9ba4322 (patch) | |
tree | 6130517808b511a157b93b40e0359f51c67257f0 /docs | |
parent | 79ccd5ed96ba22b43ecb91797c51e19eada401f2 (diff) |
[docs] Improve the rendering of our API binding APIs and runtime API documentation
Diffstat (limited to 'docs')
-rw-r--r-- | docs/exdoc | 280 | ||||
-rw-r--r-- | docs/sources/mono-api-assembly.html | 64 | ||||
-rw-r--r-- | docs/sources/mono-api-domains.html | 18 | ||||
-rw-r--r-- | docs/sources/mono-api-embedding.html | 2 | ||||
-rw-r--r-- | docs/sources/mono-api-jit.html | 8 |
5 files changed, 256 insertions, 116 deletions
diff --git a/docs/exdoc b/docs/exdoc index ce35052443e..a1ce4378b6f 100644 --- a/docs/exdoc +++ b/docs/exdoc @@ -49,64 +49,179 @@ if ($html){ <?xml version="1.0" encoding="utf-8"?> <html xmlns="http://www.w3.org/1999/xhtml"> <head> - <title>$name</title> - <style type="text/css"> - h3 { - font-size: 18px; - padding-bottom: 4pt; - border-bottom: 2px solid #dddddd; - } - + <title>$name</title> + <style type="text/css"> + body { + line-height: 1.5; + padding-left: 2em; + padding-right: 2em; + } + body code { + font-family: "Consolas", "Courier", monospace; + border: 1px solid rgba(214,214,214,1); + background-color: rgba(249,249,249,1); + padding-left: 3px; + padding-right: 3px; + } + + .api-entry code { + border: none; + background-color: transparent; + } + h3 { + } + + .api-parameters { + border-collapse: collapse; + border-spacing: 0; + empty-cells: hide; + border: 0; + margin: 5px 0 26px; + } + + .api-parameters td { + border: 1px solid rgba(214,214,214,1); + border-left-style: none; + padding: 5px 25px 5px 10px; + } + + .api-parameters tr>td:last-child { + border-right: 0; + } + + .api-parameters td:first-of-type { + text-align: right; + padding: 7px; + vertical-align: top; + word-break: normal; + width: 40px; + } + + .api-parameters tr:last-child>td { + border-bottom: 0; + } + + .api-parameters tr:first-child>td { + border-top: 0; + } + + .api-parameters tr td:first-of-type { + text-align: right; + padding: 7px; + vertical-align: top; + word-break: normal; + width: 40px; + } + .api { - padding: 10pt; - margin: 10pt; - border: 3px solid #ddd; - } - - .api-entry { - border-bottom: none; - font-size: 150%; - font-family: "Consolas", "Courier", monospace; - padding-bottom: .5em; - } - - .prototype { - border: 3px solid #ecf0f1; - border-radius: 6px; - padding: .5em; - margin-top: 5pt; - margin-bottom: 5pt; - font-family: "Consolas", "Courier", monospace; - display: block; - overflow: auto; - background-color: #f9f9f9; - } - - .header { - - padding: 0 0 5pt 5pt; - margin: 10pt; - white-space: pre; - font-family: monospace; - } + left: -25px; + margin: 0; + padding: 13px 25px 0; + position: relative; + width: 100%; + } + + .api-description { + background: rgba(249,249,249,1); + border-bottom: 1px solid rgba(233,233,233,1); + left: -25px; + margin: 0; + padding: 13px 25px 0; + position: relative; + width: 100%; + } + + .api-entry { + background: transparent; + } + + .api-docs { + } + + .prototype { + border-left: 5px solid rgba(205,233,244,1); + padding: .5em; + margin-top: 5pt; + margin-bottom: 5pt; + font-family: "Consolas", "Courier", monospace; + display: block; + overflow: auto; + background-color: #f9f9f9; + } + + .header { + padding: 0 0 5pt 5pt; + margin: 10pt; + white-space: pre; + font-family: monospace; + border: 1px solid rgba(233,233,233,1); + } - .code { - border: 1px solid; - padding: 0 0 5pt 5pt; - margin: 10pt; - white-space: pre; - font-family: monospace; - } - - .strike { - text-decoration: line-through; - } - .deprecated { - color: red; - } + .code { + border: 1px solid; + padding: 0 0 5pt 5pt; + margin: 10pt; + white-space: pre; + font-family: monospace; + } + + .declaration { + margin-top: 21px; + } + + .api-section { + font-size: smaller; + font-weight: bold; + margin-top: 21px; + line-height: 1.5; + } + + .strike { + text-decoration: line-through; + } + + .deprecated { + color: red; + } + + .api-ptr-container { + background: white; + border-bottom: 1px solid rgba(233,233,233,1); + left: -25px; + padding-left: 25px; + padding-right: 25px; + padding-bottom: 13px; + position: relative; + width: 100%; + } + + .api-ptr { + background: rgba(249,249,249,1); + border-left: 1px solid rgba(233,233,233,1); + border-top: 1px solid rgba(233,233,233,1); + height: 12px; + left: 37px; + top: -7px; + -webkit-transform: rotate(45deg); + -moz-transform: rotate(45deg); + -o-transform: rotate(45deg); + transform: rotate(45deg); + position: absolute; + width: 12px; + } + + .api-height-container { + height: 0; + left: -25px; + padding: 0 25px; + position: relative; + width: 100%; + } + </style> </head> <body> +<div class="api-docs"> EOF @a = split (/\n/, $files_content[$f]); $strikeextra = ""; @@ -131,32 +246,45 @@ EOF $proto = "Prototype: $api"; } -print OUT<<EOF; + print OUT<<EOF; <a name="api:$api"></a> <div class="api"> - <div class="api-entry $strike">$api$strikeextra</div> - <div><b>Syntax</b></div> - <div class="prototype">$proto</div> + <div class="api-entry $strike"><code>$api$strikeextra</code></div> + <div class="api-height-container"> + <div class="api-ptr-container"></div> + <div class="api-description"> + <div class="api-ptr"></div> + + <div class="declaration api-section">Syntax</div> + <div class="prototype">$proto</div> <p> EOF - &opt_print ("Parameters", $arguments{$api}, 1); - &opt_print ("Returns", $returns{$api}, 1); - &opt_print ("Description", $bodies{$api}, 0); - print OUT "\n"; + +# if ($arguments{$api} ne "" && (!($arguments{$api}) =~ /^[ \t]+$/)){ + print OUT "<div class=\"api-section\">Parameters</div>\n"; + print OUT "<table class=\"api-parameters\"><tbody>".${arguments{$api}}."</tbody></table>"; +# } +# &opt_print ("Parameters", $arguments{$api}, 1); + + &opt_print ("Returns", $returns{$api}, 1); + &opt_print ("Description", $bodies{$api}, 0); + print OUT "\n"; } else { if ($line =~ /@API_IDX@/){ $apis_toc = &create_toc ($apis[$f]); $line =~ s/\@API_IDX\@/$apis_toc/; } - if ($line =~ /^<h/){ - print OUT "</div>"; + if ($line =~ /^<h4/){ + print OUT "</div></div></div>"; $api_shown = 0; } - + if ($line =~ /`/){ + } print OUT "$line\n"; } } print OUT<<EOF; + </div> </body> </html> EOF @@ -192,11 +320,22 @@ sub process_doc { # Process arguments while (<>){ - if (/^ \*\*?\//){ - $body =~ s/[@#](\w+)/<i>\1<\/i>/g; - $returns =~ s/[@#](\w+)/<i>\1<\/i>/g; - + s/NULL/<code>NULL<\/code>/g; + s/TRUE/<code>TRUE<\/code>/g; + s/FALSE/<code>FALSE<\/code>/g; + if (/^ \*\*?\//){ + $body =~ s/@(\w+)/<i>\1<\/i>/g; + $returns =~ s/@(\w+)/<i>\1<\/i>/g; $args =~ s/@(\w+)/<i>\1<\/i>/g; + + $body =~ s/#(\w+)/<code>\1<\/code>/g; + $returns =~ s/#(\w+)/<code>\1<\/code>/g; + $args =~ s/#(\w+)/<code>\1<\/code>/g; + + $returns =~ s/\`([:\w\*]+)\`/<code>\1<\/code>/g; + $args =~ s/\`([:\w\*]+)\`/<code>\1<\/code>/g; + $body =~ s/\`([:\w\*]+)\`/<code>\1<\/code>/g; + $body =~ s/\n/ /; $bodies{$func} = $body; $arguments{$func} = $args; @@ -224,7 +363,8 @@ sub process_doc { if ($1 eq "deprecated"){ $deprecated = $2; } else { - $args .= "<dt><i>$1:</i></dt><dd>$2</dd>"; + #$args .= "<dt><i>$1:</i></dt><dd>$2</dd>"; + $args .= "<tr><td><i>$1</i><td>$2</td></td></tr>"; } } else { @@ -315,7 +455,7 @@ sub opt_print { my ($caption, $opttext, $quote) = @_; if ($opttext ne "" && (!($opttext =~ /^[ \t]+$/))){ - print OUT "<b>$caption</b>\n"; + print OUT "<div class=\"api-section\">$caption</div>\n"; if ($quote == 1){ print OUT "<blockquote>$opttext</blockquote>\n"; } else { diff --git a/docs/sources/mono-api-assembly.html b/docs/sources/mono-api-assembly.html index c38ea00f2b2..15e29583999 100644 --- a/docs/sources/mono-api-assembly.html +++ b/docs/sources/mono-api-assembly.html @@ -20,33 +20,33 @@ typedef struct _MonoAssembly MonoAssembly; <h4><a name="api:mono_assembly_load">mono_assembly_load</a></h4> <h4><a name="api:mono_assembly_load_full">mono_assembly_load_full</a></h4> <h4><a name="api:mono_assembly_loaded">mono_assembly_loaded</a></h4> -<h4><a name="api:mono_assembly_load_from">mono_assembly_load_from</a> -<h4><a name="api:mono_assembly_load_from_full">mono_assembly_load_from_full</a> -<h4><a name="api:mono_assembly_load_with_partial_name">mono_assembly_load_with_partial_name</a> +<h4><a name="api:mono_assembly_load_from">mono_assembly_load_from</a></h4> +<h4><a name="api:mono_assembly_load_from_full">mono_assembly_load_from_full</a></h4> +<h4><a name="api:mono_assembly_load_with_partial_name">mono_assembly_load_with_partial_name</a></h4> <h4><a name="api:mono_assembly_open">mono_assembly_open</a></h4> -<h4><a name="api:mono_assembly_open_full">mono_assembly_open_full</a> -<h4><a name="api:mono_set_assemblies_path">mono_set_assemblies_path</a> -<h4><a name="api:mono_set_rootdir">mono_set_rootdir</a> +<h4><a name="api:mono_assembly_open_full">mono_assembly_open_full</a></h4> +<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> <h3>Working with Assemblies</h3> -<h4><a name="api:mono_assembly_fill_assembly_name">mono_assembly_fill_assembly_name</a> -<h4><a name="api:mono_assembly_foreach">mono_assembly_foreach</a> +<h4><a name="api:mono_assembly_fill_assembly_name">mono_assembly_fill_assembly_name</a></h4> +<h4><a name="api:mono_assembly_foreach">mono_assembly_foreach</a></h4> <h4><a name="api:mono_assembly_get_image">mono_assembly_get_image</a></h4> <h4><a name="api:mono_assembly_get_main">mono_assembly_get_main</a></h4> -<h4><a name="api:mono_assembly_get_name">mono_assembly_get_name</a> +<h4><a name="api:mono_assembly_get_name">mono_assembly_get_name</a></h4> <h4><a name="api:mono_assembly_getrootdir">mono_assembly_getrootdir</a></h4> -<h4><a name="api:mono_assembly_get_assemblyref">mono_assembly_get_assemblyref</a> -<h4><a name="api:mono_assembly_loaded_full">mono_assembly_loaded_full</a> -<h4><a name="api:mono_assembly_load_reference">mono_assembly_load_reference</a> -<h4><a name="api:mono_assembly_load_references">mono_assembly_load_references</a> -<h4><a name="api:mono_assembly_load_module">mono_assembly_load_module</a> -<h4><a name="api:mono_assembly_invoke_load_hook">mono_assembly_invoke_load_hook</a> -<h4><a name="api:mono_assembly_invoke_search_hook">mono_assembly_invoke_search_hook</a> -<h4><a name="api:mono_assembly_set_main">mono_assembly_set_main</a> -<h4><a name="api:mono_assembly_setrootdir">mono_assembly_setrootdir</a> -<h4><a name="api:mono_register_config_for_assembly">mono_register_config_for_assembly</a> -<h4><a name="api:mono_register_symfile_for_assembly">mono_register_symfile_for_assembly</a> +<h4><a name="api:mono_assembly_get_assemblyref">mono_assembly_get_assemblyref</a></h4> +<h4><a name="api:mono_assembly_loaded_full">mono_assembly_loaded_full</a></h4> +<h4><a name="api:mono_assembly_load_reference">mono_assembly_load_reference</a></h4> +<h4><a name="api:mono_assembly_load_references">mono_assembly_load_references</a></h4> +<h4><a name="api:mono_assembly_load_module">mono_assembly_load_module</a></h4> +<h4><a name="api:mono_assembly_invoke_load_hook">mono_assembly_invoke_load_hook</a></h4> +<h4><a name="api:mono_assembly_invoke_search_hook">mono_assembly_invoke_search_hook</a></h4> +<h4><a name="api:mono_assembly_set_main">mono_assembly_set_main</a></h4> +<h4><a name="api:mono_assembly_setrootdir">mono_assembly_setrootdir</a></h4> +<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> <h3>Assembly Names</h3> @@ -58,11 +58,11 @@ typedef struct _MonoAssembly MonoAssembly; href="http://www.mono-project.com/monodoc/T:System.Reflection.AssemblyName">System.Reflection.AssemblyName</a> managed type. -<h4><a name="api:mono_assembly_name_new">mono_assembly_name_new</a> -<h4><a name="api:mono_assembly_name_get_name">mono_assembly_name_get_name</a> -<h4><a name="api:mono_assembly_name_get_culture">mono_assembly_name_get_culture</a> -<h4><a name="api:mono_assembly_name_get_version">mono_assembly_name_get_version</a> -<h4><a name="api:mono_assembly_name_get_pubkeytoken">mono_assembly_name_get_pubkeytoken</a> +<h4><a name="api:mono_assembly_name_new">mono_assembly_name_new</a></h4> +<h4><a name="api:mono_assembly_name_get_name">mono_assembly_name_get_name</a></h4> +<h4><a name="api:mono_assembly_name_get_culture">mono_assembly_name_get_culture</a></h4> +<h4><a name="api:mono_assembly_name_get_version">mono_assembly_name_get_version</a></h4> +<h4><a name="api:mono_assembly_name_get_pubkeytoken">mono_assembly_name_get_pubkeytoken</a></h4> <h4><a name="api:mono_assembly_name_free">mono_assembly_name_free</a></h4> <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> @@ -77,10 +77,10 @@ typedef struct _MonoAssembly MonoAssembly; <h3>Advanced</h3> -<h4><a name="api:mono_install_assembly_load_hook">mono_install_assembly_load_hook</a> -<h4><a name="api:mono_install_assembly_search_hook">mono_install_assembly_search_hook</a> -<h4><a name="api:mono_install_assembly_refonly_search_hook">mono_install_assembly_refonly_search_hook</a> -<h4><a name="api:mono_install_assembly_preload_hook">mono_install_assembly_preload_hook</a> -<h4><a name="api:mono_install_assembly_refonly_preload_hook">mono_install_assembly_refonly_preload_hook</a> -<h4><a name="api:mono_install_assembly_postload_search_hook">mono_install_assembly_postload_search_hook</a> -<h4><a name="api:mono_install_assembly_postload_refonly_search_hook">mono_install_assembly_postload_refonly_search_hook</a> +<h4><a name="api:mono_install_assembly_load_hook">mono_install_assembly_load_hook</a></h4> +<h4><a name="api:mono_install_assembly_search_hook">mono_install_assembly_search_hook</a></h4> +<h4><a name="api:mono_install_assembly_refonly_search_hook">mono_install_assembly_refonly_search_hook</a></h4> +<h4><a name="api:mono_install_assembly_preload_hook">mono_install_assembly_preload_hook</a></h4> +<h4><a name="api:mono_install_assembly_refonly_preload_hook">mono_install_assembly_refonly_preload_hook</a></h4> +<h4><a name="api:mono_install_assembly_postload_search_hook">mono_install_assembly_postload_search_hook</a></h4> +<h4><a name="api:mono_install_assembly_postload_refonly_search_hook">mono_install_assembly_postload_refonly_search_hook</a></h4> diff --git a/docs/sources/mono-api-domains.html b/docs/sources/mono-api-domains.html index b6381c786a6..9ae0bd14497 100644 --- a/docs/sources/mono-api-domains.html +++ b/docs/sources/mono-api-domains.html @@ -34,30 +34,30 @@ typedef struct _MonoAppContext MonoAppContext <h4><a name="api:mono_domain_assembly_open">mono_domain_assembly_open</a></h4> <h4><a name="api:mono_domain_create">mono_domain_create</a></h4> -<h4><a name="api:mono_domain_create_appdomain">mono_domain_create_appdomain</a> +<h4><a name="api:mono_domain_create_appdomain">mono_domain_create_appdomain</a></h4> <h4><a name="api:mono_domain_finalize">mono_domain_finalize</a></h4> <h4><a name="api:mono_domain_foreach">mono_domain_foreach</a></h4> <h4><a name="api:mono_domain_free">mono_domain_free</a></h4> -<h4><a name="api:mono_domain_from_appdomain">mono_domain_from_appdomain</a> +<h4><a name="api:mono_domain_from_appdomain">mono_domain_from_appdomain</a></h4> <h4><a name="api:mono_domain_get_by_id">mono_domain_get_by_id</a></h4> -<h4><a name="api:mono_domain_get_friendly_name">mono_domain_get_friendly_name</a> +<h4><a name="api:mono_domain_get_friendly_name">mono_domain_get_friendly_name</a></h4> <h4><a name="api:mono_domain_get_id">mono_domain_get_id</a></h4> <h4><a name="api:mono_domain_get">mono_domain_get</a></h4> <h4><a name="api:mono_domain_has_type_resolve">mono_domain_has_type_resolve</a></h4> <h4><a name="api:mono_domain_is_unloading">mono_domain_is_unloading</a></h4> <h4><a name="api:mono_domain_owns_vtable_slot">mono_domain_owns_vtable_slot</a></h4> -<h4><a name="api:mono_domain_set_config">mono_domain_set_config</a> +<h4><a name="api:mono_domain_set_config">mono_domain_set_config</a></h4> <h4><a name="api:mono_domain_set_internal">mono_domain_set_internal</a></h4> <h4><a name="api:mono_domain_set">mono_domain_set</a></h4> <h4><a name="api:mono_domain_try_type_resolve">mono_domain_try_type_resolve</a></h4> -<h4><a name="api:mono_domain_try_unload">mono_domain_try_unload</a> -<h4><a name="api:mono_domain_unload">mono_domain_unload</a> +<h4><a name="api:mono_domain_try_unload">mono_domain_try_unload</a></h4> +<h4><a name="api:mono_domain_unload">mono_domain_unload</a></h4> <h3>Contexts</h3> -<h4><a name="api:mono_context_init">mono_context_init</a> +<h4><a name="api:mono_context_init">mono_context_init</a></h4> <h4><a name="api:mono_context_get">mono_context_get</a></h4> -<h4><a name="api:mono_context_get_domain_id">mono_context_get_domain_id</a> -<h4><a name="api:mono_context_get_id">mono_context_get_id</a> +<h4><a name="api:mono_context_get_domain_id">mono_context_get_domain_id</a></h4> +<h4><a name="api:mono_context_get_id">mono_context_get_id</a></h4> <h4><a name="api:mono_context_set">mono_context_set</a></h4> <h4><a name="api:mono_context_get_desc">mono_context_get_desc</a></h4> diff --git a/docs/sources/mono-api-embedding.html b/docs/sources/mono-api-embedding.html index 1199c45697b..4c4329f634a 100644 --- a/docs/sources/mono-api-embedding.html +++ b/docs/sources/mono-api-embedding.html @@ -150,7 +150,7 @@ getMessage () <h4><a name="api:mono_config_string_for_assembly_file">mono_config_string_for_assembly_file</a></h4> <h4><a name="api:mono_get_config_dir">mono_get_config_dir</a></h4> <h4><a name="api:mono_get_machine_config">mono_get_machine_config</a></h4> -<h4><a name="api:mono_register_machine_config">mono_register_machine_config</a> +<h4><a name="api:mono_register_machine_config">mono_register_machine_config</a></h4> <h4><a name="api:mono_set_config_dir">mono_set_config_dir</a></h4> <h3>Advanced Execution Setups</h3> diff --git a/docs/sources/mono-api-jit.html b/docs/sources/mono-api-jit.html index d21b08fc6fd..14548c4e9d3 100644 --- a/docs/sources/mono-api-jit.html +++ b/docs/sources/mono-api-jit.html @@ -7,10 +7,10 @@ <h3>JIT Information</h3> -<h4><a name="api:mono_jit_info_get_code_size">mono_jit_info_get_code_size</a> -<h4><a name="api:mono_jit_info_get_code_start">mono_jit_info_get_code_start</a> -<h4><a name="api:mono_jit_info_get_method">mono_jit_info_get_method</a> -<h4><a name="api:mono_jit_info_table_find">mono_jit_info_table_find</a> +<h4><a name="api:mono_jit_info_get_code_size">mono_jit_info_get_code_size</a></h4> +<h4><a name="api:mono_jit_info_get_code_start">mono_jit_info_get_code_start</a></h4> +<h4><a name="api:mono_jit_info_get_method">mono_jit_info_get_method</a></h4> +<h4><a name="api:mono_jit_info_table_find">mono_jit_info_table_find</a></h4> <h3>Useful Debugging Functions</h3> |