[valadoc] Html: Include signatures in content lists



commit 134be37345097d890502f3d663c0f756818e0304
Author: Didier "Ptitjes <ptitjes free fr>
Date:   Tue Oct 20 03:20:09 2009 +0200

    Html: Include signatures in content lists

 src/doclets/htm/doclet/doclet.vala          |    8 --------
 src/doclets/htmlhelpers/deps/style.css      |    6 ++++--
 src/doclets/htmlhelpers/doclet/doclet.vala  |   25 ++++++++++++++++++++-----
 src/doclets/htmlhelpers/doclet/globals.vala |    1 +
 4 files changed, 25 insertions(+), 15 deletions(-)
---
diff --git a/src/doclets/htm/doclet/doclet.vala b/src/doclets/htm/doclet/doclet.vala
index de41e1d..58b3685 100755
--- a/src/doclets/htm/doclet/doclet.vala
+++ b/src/doclets/htm/doclet/doclet.vala
@@ -192,14 +192,6 @@ public class Valadoc.HtmlDoclet : Valadoc.Html.BasicDoclet {
 		node.accept_all_children (this);
 	}
 
-	private bool is_internal_node (Api.Node node) {
-		return node is Package
-		       || node is Namespace
-		       || node is Interface
-		       || node is Class
-		       || node is Struct;
-	}
-
 	public override void visit_interface (Interface item) {
 		process_node (item);
 	}
diff --git a/src/doclets/htmlhelpers/deps/style.css b/src/doclets/htmlhelpers/deps/style.css
index 053bc15..963b1cf 100644
--- a/src/doclets/htmlhelpers/deps/style.css
+++ b/src/doclets/htmlhelpers/deps/style.css
@@ -153,8 +153,10 @@ div.main_code_definition {
 	margin: 10px;
 }
 
-
-
+div.leaf_brief_description {
+	display: block;
+	margin-left: 40px;
+}
 
 
 h1.main_title {
diff --git a/src/doclets/htmlhelpers/doclet/doclet.vala b/src/doclets/htmlhelpers/doclet/doclet.vala
index 98f29cb..83dc35c 100755
--- a/src/doclets/htmlhelpers/doclet/doclet.vala
+++ b/src/doclets/htmlhelpers/doclet/doclet.vala
@@ -252,7 +252,6 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet {
 		Gee.List<Block> description = doctree.content;
 		if (description.size > 0) {
 			writer.start_tag ("span", css_brief_description);
-			writer.text (" - ");
 
 			_renderer.set_container (pos);
 			_renderer.render_children (description.get (0));
@@ -275,10 +274,16 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet {
 	}
 
 	private void write_signature (Api.Node element , Api.Node? pos) {
-		writer.start_tag ("div", css_code_definition);
 		_renderer.set_container (pos);
 		_renderer.render (element.signature);
-		writer.end_tag ("div");
+	}
+
+	protected bool is_internal_node (Api.Node node) {
+		return node is Package
+		       || node is Namespace
+		       || node is Interface
+		       || node is Class
+		       || node is Struct;
 	}
 
 	public void write_navi_packages_inline (Api.Tree tree) {
@@ -329,7 +334,9 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet {
 		writer.simple_tag ("hr", css_headline_hr);
 		this.write_image_block (node);
 		writer.start_tag ("h2", css_title).text ("Description:").end_tag ("h2");
+		writer.start_tag ("div", css_code_definition);
 		this.write_signature (node, node);
+		writer.end_tag ("div");
 		this.write_documentation (node, node);
 
 		if (node.parent is Namespace) {
@@ -443,8 +450,16 @@ public abstract class Valadoc.Html.BasicDoclet : Api.Visitor, Doclet {
 			writer.start_tag ("ul", css_inline_navigation);
 			foreach (Api.Node child in children) {
 				writer.start_tag ("li", get_html_css_class (child));
-				writer.link (get_link (child, container), child.name);
-				this.write_brief_description (child, container);
+				if (is_internal_node (child)) {
+					writer.link (get_link (child, container), child.name);
+					writer.text (" - ");
+					write_brief_description (child, container);
+				} else {
+					write_signature (child, container);
+					writer.start_tag ("div", css_leaf_brief_description);
+					write_brief_description (child, container);
+					writer.end_tag ("div");
+				}
 				writer.end_tag ("li");
 			}
 			writer.end_tag ("ul");
diff --git a/src/doclets/htmlhelpers/doclet/globals.vala b/src/doclets/htmlhelpers/doclet/globals.vala
index 24ee3ed..57229ef 100755
--- a/src/doclets/htmlhelpers/doclet/globals.vala
+++ b/src/doclets/htmlhelpers/doclet/globals.vala
@@ -48,6 +48,7 @@ namespace Valadoc.Html {
 	public const string css_package_index = "package_index";
 	public const string css_brief_description = "brief_description";
 	public const string css_description = "description";
+	public const string css_leaf_brief_description = "leaf_brief_description";
 
 	public const string css_site_header = "site_header";
 	public const string css_navi = "navi_main";



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]