From: Florian Brosch <flo.brosch@gmail.com>
Date: Tue, 26 Aug 2014 01:46:09 +0000 (+0200)
Subject: gir-importer: docbook: process all <doc-* tags
X-Git-Tag: 0.37.1~3^2~47
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2dc8e00ddfea221e5592d0e7cfbf0cbe1c031d57;p=thirdparty%2Fvala.git

gir-importer: docbook: process all <doc-* tags
---

diff --git a/src/libvaladoc/documentation/gtkdoccommentparser.vala b/src/libvaladoc/documentation/gtkdoccommentparser.vala
index 372b0590a..0f4babe5c 100644
--- a/src/libvaladoc/documentation/gtkdoccommentparser.vala
+++ b/src/libvaladoc/documentation/gtkdoccommentparser.vala
@@ -1,6 +1,6 @@
 /* gtkcommentparser.vala
  *
- * Copyright (C) 2011-2012  Florian Brosch
+ * Copyright (C) 2011-2014  Florian Brosch
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
@@ -115,59 +115,114 @@ public class Valadoc.Gtkdoc.Parser : Object, ResourceLocator {
 		}
 	}
 
+	private Note? _parse_note (Api.SourceComment comment) {
+		Comment? cmnt = parse_root_content (comment);
+		if (cmnt == null) {
+			return null;
+		}
+
+		Note note = factory.create_note ();
+		note.content.add_all (cmnt.content);
+
+		return note;
+	}
+
+	private void add_note (ref Comment? comment, Note? note) {
+		if (note == null) {
+			return ;
+		}
+
+		if (comment == null) {
+			comment = factory.create_comment ();
+		}
+
+		if (comment.content.size == 0) {
+			comment.content.add (factory.create_paragraph ());
+		}
+
+		comment.content.insert (1, note);
+	}
+
+	private void add_taglet (ref Comment? comment, Taglet? taglet) {
+		if (taglet == null) {
+			return ;
+		}
+
+		if (comment == null) {
+			comment = factory.create_comment ();
+		}
+
+		comment.taglets.add (taglet);
+	}
+
 	public Comment? parse (Api.Node element, Api.GirSourceComment gir_comment, GirMetaData gir_metadata, Importer.InternalIdRegistrar id_registrar) {
 		this.instance_param_name = gir_comment.instance_param_name;
 		this.current_metadata = gir_metadata;
 		this.id_registrar = id_registrar;
 		this.element = element;
 
-		Comment? comment = this.parse_main_content (gir_comment);
-		if (comment == null) {
-			return null;
+
+		Comment? cmnt = parse_root_content (gir_comment);
+		if (cmnt != null) {
+			ImporterHelper.extract_short_desc (cmnt, factory);
 		}
 
-		if (gir_comment.return_comment != null) {
-			Taglet? taglet = this.parse_block_taglet (gir_comment.return_comment, "return");
-			if (taglet == null) {
-				return null;
-			}
 
-			comment.taglets.add (taglet);
+		// deprecated:
+		if (gir_comment.deprecated_comment != null) {
+			Note? note = _parse_note (gir_comment.deprecated_comment);
+			add_note (ref cmnt, note);
 		}
 
-		MapIterator<string, Api.SourceComment> iter = gir_comment.parameter_iterator ();
-		for (bool has_next = iter.next (); has_next; has_next = iter.next ()) {
-			Taglets.Param? taglet = this.parse_block_taglet (iter.get_value (), "param") as Taglets.Param;
-			if (taglet == null) {
-				return null;
-			}
 
-			taglet.parameter_name = iter.get_key ();
+		// version:
+		if (gir_comment.version_comment != null) {
+			Note? note = _parse_note (gir_comment.version_comment);
+			add_note (ref cmnt, note);
+		}
+
+		// stability:
+		if (gir_comment.stability_comment != null) {
+			Note? note = _parse_note (gir_comment.stability_comment);
+			add_note (ref cmnt, note);
+		}
 
-			if (taglet.parameter_name == gir_comment.instance_param_name) {
-				taglet.parameter_name = "this";
-				taglet.is_c_self_param = true;
-			}
 
-			comment.taglets.add (taglet);
+		// return:
+		if (gir_comment.return_comment != null) {
+			Taglet? taglet = parse_block_taglet (gir_comment.return_comment, "return");
+			add_taglet (ref cmnt, taglet);
+		}
+
+
+		// parameters:
+		MapIterator<string, Api.SourceComment> iter = gir_comment.parameter_iterator ();
+		for (bool has_next = iter.next (); has_next; has_next = iter.next ()) {
+			Taglets.Param? taglet = parse_block_taglet (iter.get_value (), "param") as Taglets.Param;
+			string param_name = iter.get_key ();
+
+			taglet.is_c_self_param = (param_name == gir_comment.instance_param_name);
+			taglet.parameter_name = param_name;
+			add_taglet (ref cmnt, taglet);
 		}
 
+
 		bool first = true;
 		foreach (LinkedList<Block> note in this.footnotes) {
 			if (first == true && note.size > 0) {
 				Paragraph p = note.first () as Paragraph;
 				if (p == null) {
 					p = factory.create_paragraph ();
-					comment.content.add (p);
+					cmnt.content.add (p);
 				}
 
 				p.content.insert (0, factory.create_text ("\n"));
 			}
-			comment.content.add_all (note);
+			cmnt.content.add_all (note);
 			first = false;
 		}
 
-		return comment;
+		return cmnt;
 	}
 
 	private Taglet? parse_block_taglet (Api.SourceComment gir_comment, string taglet_name) {
@@ -192,7 +247,7 @@ public class Valadoc.Gtkdoc.Parser : Object, ResourceLocator {
 		return taglet as Taglet;
 	}
 
-	private Comment? parse_main_content (Api.GirSourceComment gir_comment) {
+	private Comment? parse_root_content (Api.SourceComment gir_comment) {
 		this.reset (gir_comment);
 		current = null;
 
@@ -391,7 +446,9 @@ public class Valadoc.Gtkdoc.Parser : Object, ResourceLocator {
 		}
 
 		string id = current.attributes.get ("id");
-		id_registrar.register_symbol (id, element);
+		if (id != null) {
+			id_registrar.register_symbol (id, element);
+		}
 		next ();
 
 		if (!check_xml_close_tag ("anchor")) {
@@ -844,7 +901,9 @@ public class Valadoc.Gtkdoc.Parser : Object, ResourceLocator {
 		}
 
 		string id = current.attributes.get ("id");
-		id_registrar.register_symbol (id, element);
+		if (id != null) {
+			id_registrar.register_symbol (id, element);
+		}
 		next ();
 
 		parse_docbook_spaces ();
@@ -1117,7 +1176,9 @@ public class Valadoc.Gtkdoc.Parser : Object, ResourceLocator {
 		}
 
 		string id = current.attributes.get ("id");
-		id_registrar.register_symbol (id, element);
+		if (id != null) {
+			id_registrar.register_symbol (id, element);
+		}
 		next ();
 
 		LinkedList<Block> content = parse_mixed_content ();