From: Florian Brosch <flo.brosch@gmail.com>
Date: Sun, 27 Feb 2011 16:08:18 +0000 (+0100)
Subject: libvaladoc/api: Add API documentation for Visitor
X-Git-Tag: 0.37.1~3^2~372
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=3d5f7e2fe7ee6a49e1e1ff37d66879dcaa6c5164;p=thirdparty%2Fvala.git

libvaladoc/api: Add API documentation for Visitor
---

diff --git a/src/libvaladoc/api/visitor.vala b/src/libvaladoc/api/visitor.vala
index 07cdc8b7c..bf66a456b 100755
--- a/src/libvaladoc/api/visitor.vala
+++ b/src/libvaladoc/api/visitor.vala
@@ -20,58 +20,152 @@
  * 	Didier 'Ptitjes Villevalois <ptitjes@free.fr>
  */
 
+
+/**
+ * Abstract visitor for traversing API.
+ */
 public abstract class Valadoc.Api.Visitor : GLib.Object {
+	/**
+	 * Visit operation called for api trees.
+	 *
+	 * @param item a tree
+	 */
 	public virtual void visit_tree (Tree item) {
 	}
 
+	/**
+	 * Visit operation called for packages like gir-files and vapi-files.
+	 *
+	 * @param item a package
+	 */
 	public virtual void visit_package (Package item) {
 	}
 
+	/**
+	 * Visit operation called for namespaces
+	 *
+	 * @param item a namespace
+	 */
 	public virtual void visit_namespace (Namespace item) {
 	}
 
+	/**
+	 * Visit operation called for interfaces.
+	 *
+	 * @param item a interface
+	 */
 	public virtual void visit_interface (Interface item) {
 	}
 
+	/**
+	 * Visit operation called for classes.
+	 *
+	 * @param item a class
+	 */
 	public virtual void visit_class (Class item) {
 	}
 
+	/**
+	 * Visit operation called for structs.
+	 *
+	 * @param item a struct
+	 */
 	public virtual void visit_struct (Struct item) {
 	}
 
+	/**
+	 * Visit operation called for properties.
+	 *
+	 * @param item a property
+	 */
 	public virtual void visit_property (Property item) {
 	}
 
+	/**
+	 * Visit operation called for fields.
+	 *
+	 * @param item a field
+	 */
 	public virtual void visit_field (Field item) {
 	}
 
+	/**
+	 * Visit operation called for constants.
+	 *
+	 * @param item a constant
+	 */
 	public virtual void visit_constant (Constant item) {
 	}
 
+	/**
+	 * Visit operation called for delegates.
+	 *
+	 * @param item a delegate
+	 */
 	public virtual void visit_delegate (Delegate item) {
 	}
 
+	/**
+	 * Visit operation called for signals.
+	 *
+	 * @param item a signal
+	 */
 	public virtual void visit_signal (Signal item) {
 	}
 
+	/**
+	 * Visit operation called for methods.
+	 *
+	 * @param item a method
+	 */
 	public virtual void visit_method (Method item) {
 	}
 
+	/**
+	 * Visit operation called for type parameters.
+	 *
+	 * @param item a type parameter
+	 */
 	public virtual void visit_type_parameter (TypeParameter item) {
 	}
 
+	/**
+	 * Visit operation called for formal parameters.
+	 *
+	 * @param item a formal parameter
+	 */
 	public virtual void visit_formal_parameter (FormalParameter item) {
 	}
 
+	/**
+	 * Visit operation called for error domains.
+	 *
+	 * @param item a error domain
+	 */
 	public virtual void visit_error_domain (ErrorDomain item) {
 	}
 
+	/**
+	 * Visit operation called for error codes.
+	 *
+	 * @param item a error code
+	 */
 	public virtual void visit_error_code (ErrorCode item) {
 	}
 
+	/**
+	 * Visit operation called for enums.
+	 *
+	 * @param item a enum
+	 */
 	public virtual void visit_enum (Enum item) {
 	}
 
+	/**
+	 * Visit operation called for enum values.
+	 *
+	 * @param item a enum value
+	 */
 	public virtual void visit_enum_value (EnumValue item) {
 	}
 }