valadoc r8 - in trunk: . src/doclets/devhelp src/doclets/devhelp/deps src/doclets/devhelp/doclet src/doclets/devhelp/linkhelper src/doclets/html/doclet src/doclets/html/linkhelper src/doclets/valadoc.org/doclet src/doclets/valadoc.org/linkhelper src/libvaladoc src/valadoc
- From: flobrosch svn gnome org
- To: svn-commits-list gnome org
- Subject: valadoc r8 - in trunk: . src/doclets/devhelp src/doclets/devhelp/deps src/doclets/devhelp/doclet src/doclets/devhelp/linkhelper src/doclets/html/doclet src/doclets/html/linkhelper src/doclets/valadoc.org/doclet src/doclets/valadoc.org/linkhelper src/libvaladoc src/valadoc
- Date: Sun, 2 Nov 2008 19:33:58 +0000 (UTC)
Author: flobrosch
Date: Sun Nov 2 19:33:58 2008
New Revision: 8
URL: http://svn.gnome.org/viewvc/valadoc?rev=8&view=rev
Log:
valadoc.org-doclet:
* highlighting for abstract classes
* new symbol order (namespaces, constructors, classes, interfaces, structs, enums, errordomains, delegates, methods, signals, properties, fields, constants)
* cleanups
html-doclet:
* highlighting for abstract classes
* new symbol order
* cleanups
devhelp-doclet:
* highlighting for abstract classes
* new symbol order
* small bugfixes (devhelp-writer)
* cleanups
drawer:
* highlighting for abstract classes
Added:
trunk/src/doclets/devhelp/deps/
trunk/src/doclets/devhelp/deps/Makefile.am
trunk/src/doclets/devhelp/deps/class.png (contents, props changed)
trunk/src/doclets/devhelp/deps/constant.png (contents, props changed)
trunk/src/doclets/devhelp/deps/delegate.png (contents, props changed)
trunk/src/doclets/devhelp/deps/enum.png (contents, props changed)
trunk/src/doclets/devhelp/deps/errordomain.png (contents, props changed)
trunk/src/doclets/devhelp/deps/field.png (contents, props changed)
trunk/src/doclets/devhelp/deps/interface.png (contents, props changed)
trunk/src/doclets/devhelp/deps/method.png (contents, props changed)
trunk/src/doclets/devhelp/deps/namespace.png (contents, props changed)
trunk/src/doclets/devhelp/deps/package.png (contents, props changed)
trunk/src/doclets/devhelp/deps/packages.png (contents, props changed)
trunk/src/doclets/devhelp/deps/property.png (contents, props changed)
trunk/src/doclets/devhelp/deps/signal.png (contents, props changed)
trunk/src/doclets/devhelp/deps/struct.png (contents, props changed)
trunk/src/doclets/devhelp/deps/style.css
trunk/src/doclets/devhelp/doclet/docletconfig.vapi
Modified:
trunk/config.h.in
trunk/configure.in
trunk/src/doclets/devhelp/Makefile.am
trunk/src/doclets/devhelp/doclet/Makefile.am
trunk/src/doclets/devhelp/doclet/template.vala
trunk/src/doclets/devhelp/linkhelper/helper.vala
trunk/src/doclets/html/doclet/template.vala
trunk/src/doclets/html/linkhelper/helper.vala
trunk/src/doclets/valadoc.org/doclet/template.vala
trunk/src/doclets/valadoc.org/linkhelper/helper.vala
trunk/src/libvaladoc/doctree.vala
trunk/src/libvaladoc/drawer.vala
trunk/src/libvaladoc/settings.vala
trunk/src/valadoc/valadoc.vala
Modified: trunk/config.h.in
==============================================================================
--- trunk/config.h.in (original)
+++ trunk/config.h.in Sun Nov 2 19:33:58 2008
@@ -30,6 +30,10 @@
/* Define to 1 if you have the <unistd.h> header file. */
#undef HAVE_UNISTD_H
+/* Define to the sub-directory in which libtool stores uninstalled libraries.
+ */
+#undef LT_OBJDIR
+
/* Name of package */
#undef PACKAGE
Modified: trunk/configure.in
==============================================================================
--- trunk/configure.in (original)
+++ trunk/configure.in Sun Nov 2 19:33:58 2008
@@ -78,6 +78,7 @@
src/doclets/valadoc.org/taglets/link/Makefile
src/doclets/valadoc.org/taglets/see/Makefile
src/doclets/devhelp/Makefile
+ src/doclets/devhelp/deps/Makefile
src/doclets/devhelp/linkhelper/Makefile
src/doclets/devhelp/doclet/Makefile
src/doclets/devhelp/taglets/Makefile
Modified: trunk/src/doclets/devhelp/Makefile.am
==============================================================================
--- trunk/src/doclets/devhelp/Makefile.am (original)
+++ trunk/src/doclets/devhelp/Makefile.am Sun Nov 2 19:33:58 2008
@@ -7,10 +7,7 @@
linkhelper \
doclet \
taglets \
+ deps \
$(NULL)
-# langlet \
-# doclet \
-# $(NULL)
-
Added: trunk/src/doclets/devhelp/deps/Makefile.am
==============================================================================
--- (empty file)
+++ trunk/src/doclets/devhelp/deps/Makefile.am Sun Nov 2 19:33:58 2008
@@ -0,0 +1,29 @@
+NULL =
+
+
+vapidir = $(libdir)/valadoc/plugins/devhelp/deps/
+
+
+dist_vapi_DATA = \
+ style.css \
+ class.png \
+ interface.png \
+ packages.png \
+ constant.png \
+ method.png \
+ property.png \
+ delegate.png \
+ errordomain.png \
+ namespace.png \
+ signal.png \
+ enum.png \
+ field.png \
+ package.png \
+ struct.png \
+ $(NULL)
+
+dist_noinst_DATA = \
+ $(NULL)
+
+
+
Added: trunk/src/doclets/devhelp/deps/class.png
==============================================================================
Binary file. No diff available.
Added: trunk/src/doclets/devhelp/deps/constant.png
==============================================================================
Binary file. No diff available.
Added: trunk/src/doclets/devhelp/deps/delegate.png
==============================================================================
Binary file. No diff available.
Added: trunk/src/doclets/devhelp/deps/enum.png
==============================================================================
Binary file. No diff available.
Added: trunk/src/doclets/devhelp/deps/errordomain.png
==============================================================================
Binary file. No diff available.
Added: trunk/src/doclets/devhelp/deps/field.png
==============================================================================
Binary file. No diff available.
Added: trunk/src/doclets/devhelp/deps/interface.png
==============================================================================
Binary file. No diff available.
Added: trunk/src/doclets/devhelp/deps/method.png
==============================================================================
Binary file. No diff available.
Added: trunk/src/doclets/devhelp/deps/namespace.png
==============================================================================
Binary file. No diff available.
Added: trunk/src/doclets/devhelp/deps/package.png
==============================================================================
Binary file. No diff available.
Added: trunk/src/doclets/devhelp/deps/packages.png
==============================================================================
Binary file. No diff available.
Added: trunk/src/doclets/devhelp/deps/property.png
==============================================================================
Binary file. No diff available.
Added: trunk/src/doclets/devhelp/deps/signal.png
==============================================================================
Binary file. No diff available.
Added: trunk/src/doclets/devhelp/deps/struct.png
==============================================================================
Binary file. No diff available.
Added: trunk/src/doclets/devhelp/deps/style.css
==============================================================================
--- (empty file)
+++ trunk/src/doclets/devhelp/deps/style.css Sun Nov 2 19:33:58 2008
@@ -0,0 +1,265 @@
+ul.external_link {
+}
+
+
+.main_optional_parameter {
+ font-style: italic;
+}
+
+
+
+.main_diagram {
+ display: block;
+ margin: 0px auto;
+ width: 100px;
+}
+
+.site_navi {
+ text-align: right;;
+}
+
+
+div.cms_message {
+}
+
+
+input {
+ border-color: #aaaaff;
+ border-style: solid;
+ border-width: 1px;
+}
+
+
+
+
+.site_header {
+ font-size: 25px;
+ padding-bottom: 10px;
+ padding-top: 10px;
+ background-color: #aaaaff;
+ width: 100%;
+}
+
+
+div {
+ font-family:'Verdana';
+ font-size: 12;
+}
+
+
+.site_title {
+ text-align: left;
+ font-size: 40;
+}
+
+div.site_foother {
+ text-align: center;
+ background-color: #aaaaff;
+ padding-bottom: 5px;
+ padding-top: 5px;
+ width: 100%;
+ clear: left;
+}
+
+
+div.site_body {
+ font-size: 10;
+}
+
+
+div.site_navigation {
+ float: left;
+
+ width: 240px;
+ border-color: #aaaaff;
+ border-style: solid;
+ border-width: 1px;
+ background-color: #eeeeff;
+}
+
+
+.site_content {
+ font-size: 10px;
+ margin-left: 255px;
+ margin-right: 5px;
+ text-align: left;
+}
+
+
+.main_other_type {
+ text-decoration: none;
+ font-style: italic;
+ color: #000000;
+}
+
+.main_basic_type {
+ text-decoration: none;
+ font-weight: bold;
+ color: #2e8b57;
+}
+
+.main_keyword {
+ text-decoration: none;
+ font-weight: bold;
+ color: #a52a2a;
+}
+
+
+div.main_code_definition {
+ padding-right: 10px;
+ padding-left: 10px;
+ padding-bottom: 5px;
+ padding-top: 5px;
+
+ font: monospace;
+ font-size: 10;
+ border-color: #aaaaff;
+ background-color: #eeeeff;
+ border-style: solid;
+ border-width: 1px;
+ margin: 10px;
+}
+
+
+
+
+
+h1.main_title {
+ font-size: 20px;
+ margin-bottom: 0px;
+}
+
+h2.main_title {
+ margin-bottom: 0px;
+}
+
+h3.main_title {
+ margin-bottom: 0px;
+}
+
+.main_hr {
+ border: 0;
+ color: #aaaaff;
+ background-color: #aaaaff;
+ height: 1px;
+ margin-top: 5px;
+ margin-bottom: 5px;
+}
+
+
+
+.main_parameter_table_text, .main_errordomain_table_text, .main_enum_table_text {
+}
+
+.main_parameter_table_name, .main_errordomain_table_name, .main_enum_table_name {
+ vertical-align: top;
+ text-align: right;
+ font-weight: bold;
+ width: 120px;
+ padding-right: 10px;
+}
+
+.main_parameter_table, .main_errordomain_table, .main_enum_table {
+ margin-weight: 20px;
+ margin-left: 20px;
+}
+
+
+
+
+
+
+
+.navi_package_index, .main_inline_navigation_package {
+ list-style-image: url(packages.png)
+}
+.main_navi_enval {
+ list-style-image: url(enumvalue.png)
+}
+.main_navi_errdomcode {
+ list-style-image: url(errorcode.png)
+}
+.navi_construction_method, .main_list_m {
+ list-style-image: url(method.png)
+}
+.navi_error_domain, .main_list_errdom {
+ list-style-image: url(errordomain.png)
+}
+.navi_namespace, .main_list_ns, .main_inline_navigation_namespace {
+ list-style-image: url(namespace.png)
+}
+.navi_method, .main_inline_navigation_method {
+ list-style-image: url(method.png)
+}
+.navi_struct, .main_list_stru {
+ list-style-image: url(struct.png)
+}
+.navi_iface, .main_list_iface {
+ list-style-image: url(interface.png)
+}
+.navi_field, .main_inline_navigation_fields, .main_list_field {
+ list-style-image: url(field.png)
+}
+.navi_class, .main_inline_navigation_class, .main_list_cl {
+ list-style-image: url(class.png)
+}
+.navi_enum, .main_list_en {
+ list-style-image: url(enum.png)
+}
+.navi_prop, .main_inline_navigation_property, .main_list_prop {
+ list-style-image: url(property.png)
+}
+.navi_del, .main_list_del, .main_inline_navigation_delegate {
+ list-style-image: url(delegate.png)
+}
+.navi_sig, .main_inline_navigation_signal, .main_list_sig {
+ list-style-image: url(signal.png)
+}
+.navi_package, .main_inline_navigation_package {
+ list-style-image: url(package.png)
+}
+
+.main_inline_navigation_constant, .navi_constant {
+ list-style-image: url(constant.png)
+}
+
+
+.navi_main {
+ margin-top: 10px;
+ margin-bottom: 10px;
+ padding-left: 30px;
+}
+
+.navi_hr {
+ border: 0;
+ color: #aaaaff;
+ background-color: #aaaaff;
+ height: 1px;
+ margin-left: 10px;
+ margin-right: 10px;
+ margin-top: 5px;
+ margin-bottom: 5px;
+}
+
+
+
+
+a.navi_link, a.external_link {
+ text-decoration: none;
+ color: #214b87;
+}
+
+a.navi_link:hover, a.external_link:hover {
+ text-decoration: underline;
+# color: #ff0000;
+}
+
+
+
+
+.main_see_list {
+}
+
+.main_inline_navigation {
+}
+
Modified: trunk/src/doclets/devhelp/doclet/Makefile.am
==============================================================================
--- trunk/src/doclets/devhelp/doclet/Makefile.am (original)
+++ trunk/src/doclets/devhelp/doclet/Makefile.am Sun Nov 2 19:33:58 2008
@@ -12,7 +12,7 @@
libdoclet.vala.stamp: $(libdoclet_VALASOURCES)
- $(VALAC) -C --vapidir ../../../vapi --pkg valadoc-1.0 --vapidir ../linkhelper --pkg libxml-2.0 --pkg libhtmlhelper-1.0 --basedir . --disable-non-null --save-temps $^
+ $(VALAC) -C --vapidir ../../../vapi --pkg valadoc-1.0 --vapidir ../linkhelper --pkg libxml-2.0 --pkg libhtmlhelper-1.0 --vapidir . --pkg docletconfig --basedir . --disable-non-null --save-temps $^
touch $@
@@ -32,6 +32,7 @@
AM_CFLAGS = -g \
+ -DPACKAGE_PLUGINDIR=\"$(libdir)/valadoc/plugins/devhelp/\" \
-I ../../../libvaladoc/ \
-I ../linkhelper/ \
-I ../ \
Added: trunk/src/doclets/devhelp/doclet/docletconfig.vapi
==============================================================================
--- (empty file)
+++ trunk/src/doclets/devhelp/doclet/docletconfig.vapi Sun Nov 2 19:33:58 2008
@@ -0,0 +1,7 @@
+
+
+[CCode (cprefix = "", lower_case_cprefix = "", cheader_filename = "")]
+namespace Config {
+ [CCode (cname = "PACKAGE_PLUGINDIR")]
+ public const string doclet_path;
+}
Modified: trunk/src/doclets/devhelp/doclet/template.vala
==============================================================================
--- trunk/src/doclets/devhelp/doclet/template.vala (original)
+++ trunk/src/doclets/devhelp/doclet/template.vala Sun Nov 2 19:33:58 2008
@@ -506,16 +506,17 @@
Xml.Doc.save_format_file ( path, this.devhelp, 1 );
}
- construct {
+ public DevhelpFormat ( string name, string version ) {
this.devhelp = new Xml.Doc ( "1.0" );
- Xml.Node* root = new Xml.Node ( null, "book" ); // may cause an crash! string#
+ Xml.Node* root = new Xml.Node ( null, "book" );
this.devhelp->set_root_element( root );
root->new_prop ( "xmlns", "http://www.devhelp.net/book"; );
- root->new_prop ( "title", "GLib Reference Manual" ); // >>> Change the title!
- root->new_prop ( "link", "index.html" );
+ root->new_prop ( "title", name + " Reference Manual" );
+ root->new_prop ( "language", "vala" );
+ root->new_prop ( "link", "index.htm" );
+ root->new_prop ( "name", version );
+ root->new_prop ( "version", "2" );
root->new_prop ( "author", "" );
- root->new_prop ( "name", "glib" ); // >>> name
- root->new_prop ( "version", "2" ); // >>> version
this.current = root->new_child ( null, "chapters" );
this.functions = root->new_child ( null, "functions" );
@@ -543,16 +544,15 @@
private Xml.Node* find_child_node ( Xml.Node* element, string name ) {
for ( Xml.Node* pos = element->children; pos != null ; pos = pos->next ) {
- if ( name == pos->get_prop ( name ) ) {
+ if ( name == pos->get_prop ( "name" ) ) {
return pos;
}
}
-
return null;
}
private Xml.Node* get_node ( string full_name ) {
- Xml.Node* cur = this.functions;
+ Xml.Node* cur = this.chapters;
string[] path = full_name.split ( "." );
for ( int i = 0; path[i] != null ; i++ ) {
@@ -565,22 +565,35 @@
return null;
}
- public void devhelp_add_chapter_start ( string name, string link ) {
+ public void reset ( ) {
+ this.current = this.chapters;
+ }
+
+ public bool jump_to_chapter ( string full_name ) {
+ Xml.Node* node = this.get_node ( full_name );
+ if ( node != null ) {
+ this.current = node;
+ return true;
+ }
+ return false;
+ }
+
+ public void add_chapter_start ( string name, string link ) {
this.current = this.current->new_child ( null, "sub" );
this.current->new_prop ( "name", name );
this.current->new_prop ( "link", link );
}
- public void devhelp_add_chapter_end () {
+ public void add_chapter_end () {
this.current = this.current->parent;
}
- public void devhelp_add_chapter ( string name, string link ) {
- this.devhelp_add_chapter_start ( name, link );
- this.devhelp_add_chapter_end ();
+ public void add_chapter ( string name, string link ) {
+ this.add_chapter_start ( name, link );
+ this.add_chapter_end ();
}
- public void devhelp_add_keyword ( KeywordType type, string name, string link ) {
+ public void add_keyword ( KeywordType type, string name, string link ) {
Xml.Node* keyword = this.functions->new_child ( null, "keyword" );
keyword->new_prop ( "type", keyword_type_strings[(int)type] );
keyword->new_prop ( "name", name );
@@ -602,7 +615,7 @@
file.puts ( "<html>\n" );
file.puts ( "\t<head>\n" );
file.puts ( "\t\t<title>Vala Binding Reference</title>\n" );
- file.printf ( "\t\t<link href=\"../style.css\" rel=\"stylesheet\" type=\"text/css\" />\n" );
+ file.printf ( "\t\t<link href=\"style.css\" rel=\"stylesheet\" type=\"text/css\" />\n" );
file.puts ( "\t</head>\n" );
file.puts ( "\t<body>\n\n" );
@@ -644,8 +657,6 @@
~HtmlDoclet ( ) {
this.devhelp.save_file ( this.settings.get_real_path () + "/" + vala_file_package_name + "/" + vala_file_package_name + ".devhelp2" );
-
-// this.devhelp.save_file ( this.settings.get_real_path () + "/devhelp2.xml" );
}
public Valadoc.Settings settings {
@@ -657,10 +668,10 @@
this.settings = settings;
var rt = DirUtils.create ( this.settings.path, 0777 );
- rt = DirUtils.create ( this.settings.path + settings.package_name, 0777 );
+ rt = DirUtils.create ( this.settings.path + settings.pkg_name, 0777 );
this.langlet = new Valadoc.LangletIndex ( settings );
- this.devhelp = new DevhelpFormat ();
+ this.devhelp = new DevhelpFormat ( settings.pkg_name, "" );
}
private void write_image_block ( GLib.FileStream file, DataType element ) {
@@ -684,6 +695,7 @@
private string vala_file_package_name;
private bool visited_non_package = false;
+
public override void visit_file ( File file ) {
string pkg_name = get_package_name ( file.name );
string path = this.settings.get_real_path () + pkg_name + "/";
@@ -692,9 +704,16 @@
if ( file.is_package == true ) {
var rt = DirUtils.create ( path, 0777 );
rt = DirUtils.create ( path + "img/", 0777 );
+ copy_directory ( Config.doclet_path + "deps/", path );
+
DevhelpFormat tmp = this.devhelp;
- this.devhelp = new DevhelpFormat ();
+ this.devhelp = new DevhelpFormat ( pkg_name, "" );
+
+ GLib.FileStream ifile = GLib.FileStream.open ( path + "index.htm", "w" );
+ this.write_file_header_template ( ifile, pkg_name );
+ this.write_file_footer ( ifile );
+ ifile = null;
file.visit_namespaces ( this );
@@ -706,9 +725,17 @@
this.vala_file_package_name = pkg_name;
var rt = DirUtils.create ( path, 0777 );
rt = DirUtils.create ( path + "img/", 0777 );
+ copy_directory ( Config.doclet_path + "deps/", path );
+ this.devhelp.reset ( );
}
+ GLib.FileStream ifile = GLib.FileStream.open ( path + "index.htm", "w" );
+ this.write_file_header_template ( ifile, pkg_name );
+ this.write_file_footer ( ifile );
+ ifile = null;
+
file.visit_namespaces ( this );
+
this.visited_non_package = true;
}
}
@@ -726,26 +753,40 @@
bool file_exists = FileUtils.test ( rpath, FileTest.EXISTS);
if ( !file_exists ) {
- this.devhelp.devhelp_add_keyword ( KeywordType.NAMESPACE, ns.name, path );
-
GLib.FileStream file = GLib.FileStream.open ( rpath, "w" );
this.write_file_header_template ( file, ns.full_name() );
this.write_namespace_content ( file, ns );
this.write_file_footer ( file );
file = null;
+
+ if ( ns.name != null ) {
+ this.devhelp.add_keyword ( KeywordType.NAMESPACE, ns.name, path );
+ this.devhelp.add_chapter_start ( ns.name, path );
+ }
+ }
+ else {
+ bool available = this.devhelp.jump_to_chapter ( ns.full_name () );
+ if ( available == false ) {
+ this.devhelp.add_keyword ( KeywordType.NAMESPACE, ns.name, path );
+ this.devhelp.add_chapter_start ( ns.name, path );
+ }
}
// file:
ns.visit_namespaces ( this );
+ ns.visit_classes ( this );
+ ns.visit_interfaces ( this );
+ ns.visit_structs ( this );
ns.visit_enums ( this );
ns.visit_error_domains ( this );
- ns.visit_structs ( this );
- ns.visit_interfaces ( this );
- ns.visit_classes ( this );
ns.visit_delegates ( this );
- ns.visit_constants ( this );
- ns.visit_fields ( this );
ns.visit_methods ( this );
+ ns.visit_fields ( this );
+ ns.visit_constants ( this );
+
+ if ( ns.name != null ) {
+ this.devhelp.add_chapter_end ( );
+ }
}
private void write_child_classes ( GLib.FileStream file, ClassHandler clh ) {
@@ -754,7 +795,15 @@
file.printf ( "<h3 class=\"%s\">Classes:</h3>\n", css_title );
file.printf ( "<ul class=\"%s\">\n", css_inline_navigation );
foreach ( Class subcl in classes ) {
- file.printf ( "\t<li class=\"%s\"><a class=\"%s\" href=\"%s\">%s</a></li>\n", css_inline_navigation_class, css_navi_link, this.get_link(subcl), subcl.name );
+ string name;
+ if ( subcl.is_abstract ) {
+ name = "<i>" + subcl.name + "</i>";
+ }
+ else {
+ name = subcl.name;
+ }
+
+ file.printf ( "\t<li class=\"%s\"><a class=\"%s\" href=\"%s\">%s</a></li>\n", css_inline_navigation_class, css_navi_link, this.get_link(subcl), name );
}
file.puts ( "</ul>\n" );
}
@@ -914,18 +963,22 @@
this.write_image_block ( file, iface );
file.printf ( "<h2 class=\"%s\">Description:</h2>\n", css_title );
+
+ file.printf ( "<div class=\"%s\">\n\t", css_code_definition );
+ this.langlet.write_interface ( iface, file );
+ file.printf ( "\n</div>\n" );
+
iface.write_comment ( file );
this.write_namespace_note ( file, iface );
this.write_package_note ( file, iface );
file.printf ( "\n<h2 class=\"%s\">Content:</h2>\n", css_title );
-
this.write_child_classes ( file, iface );
this.write_child_structs ( file, iface );
this.write_child_delegates ( file, iface );
- this.write_child_fields ( file, iface );
- this.write_child_properties ( file, iface );
- this.write_child_signals ( file, iface );
this.write_child_methods ( file, iface );
+ this.write_child_signals ( file, iface );
+ this.write_child_properties ( file, iface );
+ this.write_child_fields ( file, iface );
}
public override void visit_interface ( Interface iface ) {
@@ -933,20 +986,19 @@
string path = this.get_path ( iface );
- this.devhelp.devhelp_add_chapter_start ( iface.name, path );
+ this.devhelp.add_chapter_start ( iface.name, path );
- iface.visit_properties ( this );
+ iface.visit_classes ( this );
+ iface.visit_structs ( this );
iface.visit_delegates ( this );
- iface.visit_signals ( this );
iface.visit_methods ( this );
- iface.visit_structs ( this );
+ iface.visit_signals ( this );
+ iface.visit_properties ( this );
iface.visit_fields ( this );
- iface.visit_structs ( this );
- iface.visit_classes ( this );
- this.devhelp.devhelp_add_chapter_end ( );
+ this.devhelp.add_chapter_end ( );
- this.devhelp.devhelp_add_keyword ( KeywordType.INTERFACE, iface.name, path );
+ this.devhelp.add_keyword ( KeywordType.INTERFACE, iface.name, path );
GLib.FileStream file = GLib.FileStream.open ( rpath, "w");
this.write_file_header_template ( file, iface.full_name() );
@@ -972,15 +1024,15 @@
this.write_package_note ( file, cl );
file.printf ( "\n<h2 class=\"%s\">Content:</h2>\n", css_title );
this.write_child_construction_methods ( file, cl );
- this.write_child_enums ( file, cl );
this.write_child_classes ( file, cl );
this.write_child_structs ( file, cl );
+ this.write_child_enums ( file, cl );
this.write_child_delegates ( file, cl );
- this.write_child_constants ( file, cl );
- this.write_child_fields ( file, cl );
- this.write_child_properties ( file, cl );
- this.write_child_signals ( file, cl );
this.write_child_methods ( file, cl );
+ this.write_child_signals ( file, cl );
+ this.write_child_properties ( file, cl );
+ this.write_child_fields ( file, cl );
+ this.write_child_constants ( file, cl );
}
public override void visit_class ( Class cl ) {
@@ -988,21 +1040,21 @@
string path = this.get_path ( cl );
- this.devhelp.devhelp_add_keyword ( KeywordType.CLASS, cl.name, path );
- this.devhelp.devhelp_add_chapter_start ( cl.name, path );
+ this.devhelp.add_keyword ( KeywordType.CLASS, cl.name, path );
+ this.devhelp.add_chapter_start ( cl.name, path );
- cl.visit_enums ( this );
+ cl.visit_construction_methods ( this );
cl.visit_classes ( this );
cl.visit_structs ( this );
+ cl.visit_enums ( this );
cl.visit_delegates ( this );
- cl.visit_constants ( this );
- cl.visit_construction_methods ( this );
cl.visit_methods ( this );
- cl.visit_fields ( this );
- cl.visit_properties ( this );
cl.visit_signals ( this );
+ cl.visit_properties ( this );
+ cl.visit_fields ( this );
+ cl.visit_constants ( this );
- this.devhelp.devhelp_add_chapter_end ( );
+ this.devhelp.add_chapter_end ( );
GLib.FileStream file = GLib.FileStream.open ( rpath, "w");
@@ -1029,9 +1081,9 @@
file.printf ( "\n</div>\n" );
this.write_child_construction_methods ( file, stru );
- this.write_child_constants ( file, stru );
- this.write_child_fields ( file, stru );
this.write_child_methods ( file, stru );
+ this.write_child_fields ( file, stru );
+ this.write_child_constants ( file, stru );
}
public override void visit_struct ( Struct stru ) {
@@ -1039,15 +1091,15 @@
string path = this.get_path ( stru );
- this.devhelp.devhelp_add_keyword ( KeywordType.STRUCT, stru.name, path );
- this.devhelp.devhelp_add_chapter_start ( stru.name, path );
+ this.devhelp.add_keyword ( KeywordType.STRUCT, stru.name, path );
+ this.devhelp.add_chapter_start ( stru.name, path );
- stru.visit_constants ( this );
- stru.visit_fields ( this );
stru.visit_construction_methods ( this );
stru.visit_methods ( this );
+ stru.visit_fields ( this );
+ stru.visit_constants ( this );
- this.devhelp.devhelp_add_chapter_end ( );
+ this.devhelp.add_chapter_end ( );
GLib.FileStream file = GLib.FileStream.open ( rpath, "w");
@@ -1076,8 +1128,8 @@
errdom.visit_methods ( this );
- this.devhelp.devhelp_add_keyword ( KeywordType.ERRORDOMAIN, errdom.name, path );
- this.devhelp.devhelp_add_chapter ( errdom.name, path );
+ this.devhelp.add_keyword ( KeywordType.ERRORDOMAIN, errdom.name, path );
+ this.devhelp.add_chapter ( errdom.name, path );
GLib.FileStream file = GLib.FileStream.open ( rpath, "w");
this.write_file_header_template ( file, errdom.full_name() );
@@ -1106,10 +1158,11 @@
en.visit_enum_values ( this );
en.visit_methods ( this );
- this.devhelp.devhelp_add_keyword ( KeywordType.ENUM, en.name, path );
- this.devhelp.devhelp_add_chapter ( en.name, path );
+ this.devhelp.add_keyword ( KeywordType.ENUM, en.name, path );
+ this.devhelp.add_chapter ( en.name, path );
GLib.FileStream file = GLib.FileStream.open ( rpath, "w");
+ this.write_file_header_template ( file, en.full_name() );
this.write_enum_content ( file, en );
this.write_file_footer ( file );
file = null;
@@ -1151,8 +1204,8 @@
string rpath = this.get_real_path ( prop );
string path = this.get_path ( prop );
- this.devhelp.devhelp_add_keyword ( KeywordType.PROPERTY, prop.name, path );
- this.devhelp.devhelp_add_chapter ( prop.name, path );
+ this.devhelp.add_keyword ( KeywordType.PROPERTY, prop.name, path );
+ this.devhelp.add_chapter ( prop.name, path );
GLib.FileStream file = GLib.FileStream.open ( rpath, "w");
this.write_file_header_template ( file, prop.full_name() );
@@ -1180,8 +1233,8 @@
string rpath = this.get_real_path ( constant );
string path = this.get_path ( constant );
- this.devhelp.devhelp_add_keyword ( KeywordType.VARIABLE, constant.name, path );
- this.devhelp.devhelp_add_chapter ( constant.name, path );
+ this.devhelp.add_keyword ( KeywordType.VARIABLE, constant.name, path );
+ this.devhelp.add_chapter ( constant.name, path );
GLib.FileStream file = GLib.FileStream.open ( rpath, "w");
this.write_file_header_template ( file, constant.full_name() );
@@ -1209,8 +1262,8 @@
string rpath = this.get_real_path ( field );
string path = this.get_path ( field );
- this.devhelp.devhelp_add_keyword ( KeywordType.VARIABLE, field.name, path );
- this.devhelp.devhelp_add_chapter ( field.name, path );
+ this.devhelp.add_keyword ( KeywordType.VARIABLE, field.name, path );
+ this.devhelp.add_chapter ( field.name, path );
GLib.FileStream file = GLib.FileStream.open ( rpath, "w");
this.write_file_header_template ( file, field.full_name() );
@@ -1244,8 +1297,8 @@
string rpath = this.get_real_path ( del );
string path = this.get_path ( del );
- this.devhelp.devhelp_add_keyword ( KeywordType.DELEGATE, del.name, path );
- this.devhelp.devhelp_add_chapter ( del.name, path );
+ this.devhelp.add_keyword ( KeywordType.DELEGATE, del.name, path );
+ this.devhelp.add_chapter ( del.name, path );
GLib.FileStream file = GLib.FileStream.open ( rpath, "w");
this.write_file_header_template ( file, del.full_name() );
@@ -1269,8 +1322,8 @@
string rpath = this.get_real_path ( sig );
string path = this.get_path ( sig );
- this.devhelp.devhelp_add_keyword ( KeywordType.SIGNAL, sig.name, path );
- this.devhelp.devhelp_add_chapter ( sig.name, path );
+ this.devhelp.add_keyword ( KeywordType.SIGNAL, sig.name, path );
+ this.devhelp.add_chapter ( sig.name, path );
GLib.FileStream file = GLib.FileStream.open ( rpath, "w");
this.write_file_header_template ( file, sig.full_name() );
@@ -1298,8 +1351,8 @@
string rpath = this.get_real_path ( m );
string path = this.get_path ( m );
- this.devhelp.devhelp_add_keyword ( KeywordType.FUNCTION, m.name, path );
- this.devhelp.devhelp_add_chapter ( m.name, path );
+ this.devhelp.add_keyword ( KeywordType.FUNCTION, m.name, path );
+ this.devhelp.add_chapter ( m.name, path );
GLib.FileStream file = GLib.FileStream.open ( rpath, "w");
this.write_file_header_template ( file, m.full_name() );
Modified: trunk/src/doclets/devhelp/linkhelper/helper.vala
==============================================================================
--- trunk/src/doclets/devhelp/linkhelper/helper.vala (original)
+++ trunk/src/doclets/devhelp/linkhelper/helper.vala Sun Nov 2 19:33:58 2008
@@ -89,6 +89,8 @@
public const string css_list_sig = "main_list_sig";
public const string css_list_m = "main_list_m";
+
+
public interface Valadoc.LinkHelper : Object {
private static string package_name = null;
@@ -110,12 +112,7 @@
return file_name.ndup ( file_name.size() - ".vapi".size() );
}
- if ( this.package_name == null ) {
- string file_name = this.get_dirname( settings.path );
- this.package_name = file_name; //file_name.ndup ( file_name.size() - ".vala".size() );
- }
-
- return this.package_name;
+ return this.settings.pkg_name;
}
public string get_file_name ( Valadoc.Basic tag ) {
Modified: trunk/src/doclets/html/doclet/template.vala
==============================================================================
--- trunk/src/doclets/html/doclet/template.vala (original)
+++ trunk/src/doclets/html/doclet/template.vala Sun Nov 2 19:33:58 2008
@@ -621,7 +621,13 @@
private void write_navi_entry ( GLib.FileStream file, Basic element, Basic pos, string style, bool link, bool full_name = false ) {
string name;
- if ( element is File ) {
+ if ( element is Class ) {
+ if ( ((Class)element).is_abstract )
+ name = "<i>" + element.name +"</i>";
+ else
+ name = element.name;
+ }
+ else if ( element is File ) {
string path = this.get_file_name ( element );
name = this.get_package_name ( path );
}
@@ -741,15 +747,15 @@
private void write_navi_child_namespaces_inline ( GLib.FileStream file, Namespace ns, Basic mself ) {
file.printf ( "<ul class=\"%s\">\n", css_navi );
this.write_navi_child_namespaces_without_childs ( file, ns, mself );
- this.write_navi_child_error_domains_without_childs ( file, ns, mself );
- this.write_navi_child_enums_without_childs ( file, ns, mself );
this.write_navi_child_classes_without_childs ( file, ns, mself );
this.write_navi_child_interfaces_without_childs ( file, ns, mself );
this.write_navi_child_structs_without_childs ( file, ns, mself );
+ this.write_navi_child_enums_without_childs ( file, ns, mself );
+ this.write_navi_child_error_domains_without_childs ( file, ns, mself );
this.write_navi_child_delegates ( file, ns, mself );
- this.write_navi_child_constants ( file, ns, mself );
- this.write_navi_child_fields ( file, ns, mself );
this.write_navi_child_methods ( file, ns, mself );
+ this.write_navi_child_fields ( file, ns, mself );
+ this.write_navi_child_constants ( file, ns, mself );
file.puts ( "</ul>\n" );
}
@@ -760,10 +766,10 @@
private void write_navi_struct_inline ( GLib.FileStream file, Struct stru, Basic mself ) {
file.printf ( "<ul class=\"%s\">\n", css_navi );
- this.write_navi_child_constants ( file, stru, mself );
this.write_navi_child_construction_methods ( file, stru, mself );
- this.write_navi_child_fields ( file, stru, mself );
this.write_navi_child_methods ( file, stru, mself );
+ this.write_navi_child_fields ( file, stru, mself );
+ this.write_navi_child_constants ( file, stru, mself );
file.puts ( "</ul>\n" );
}
@@ -777,10 +783,10 @@
private void write_navi_interface_inline ( GLib.FileStream file, Interface iface, Basic mself ) {
file.printf ( "<ul class=\"%s\">\n", css_navi );
this.write_navi_child_delegates ( file, iface, mself );
- this.write_navi_child_fields ( file, iface, mself );
- this.write_navi_child_properties ( file, iface, mself );
this.write_navi_child_methods ( file, iface, mself );
this.write_navi_child_signals ( file, iface, mself );
+ this.write_navi_child_properties ( file, iface, mself );
+ this.write_navi_child_fields ( file, iface, mself );
file.puts ( "</ul>\n" );
}
@@ -831,16 +837,16 @@
private void write_navi_class_inline ( GLib.FileStream file, Class cl, Basic mself ) {
file.printf ( "<ul class=\"%s\">\n", css_navi );
- this.write_navi_child_enums_without_childs ( file, cl, mself );
+ this.write_navi_child_construction_methods ( file, cl, mself );
this.write_navi_child_classes_without_childs ( file, cl, mself );
this.write_navi_child_structs_without_childs ( file, cl, mself );
+ this.write_navi_child_enums_without_childs ( file, cl, mself );
this.write_navi_child_delegates ( file, cl, mself );
- this.write_navi_child_constants ( file, cl, mself );
- this.write_navi_child_construction_methods ( file, cl, mself );
- this.write_navi_child_fields ( file, cl, mself );
- this.write_navi_child_properties ( file, cl, mself );
this.write_navi_child_methods ( file, cl, mself );
this.write_navi_child_signals ( file, cl, mself );
+ this.write_navi_child_properties ( file, cl, mself );
+ this.write_navi_child_fields ( file, cl, mself );
+ this.write_navi_child_constants ( file, cl, mself );
file.puts ( "</ul>\n" );
}
@@ -1282,15 +1288,17 @@
foreach ( NamespaceBundle nsb in nsbundle.subnamespaces ) {
this.write_navi_entry_html_template_with_link ( navi, css_navi_namespace, nsb.name + "/index.html", (nsb.name == null)? "Global Namespace" : nsb.name );
}
+
this.write_navi_child_classes_without_childs_collection ( navi, nsbundle.classes, mself );
- this.write_navi_child_methods_collection ( navi, nsbundle.methods, mself );
- this.write_navi_child_fields_collection ( navi, nsbundle.fields, mself );
- this.write_navi_child_constants_collection ( navi, nsbundle.constants, mself );
- this.write_navi_child_structs_without_childs_collection ( navi, nsbundle.structs, mself );
- this.write_navi_child_delegates_collection ( navi, nsbundle.delegates, mself );
this.write_navi_child_interfaces_without_childs_collection ( navi, nsbundle.interfaces, mself );
+ this.write_navi_child_structs_without_childs_collection ( navi, nsbundle.structs, mself );
this.write_navi_child_enums_without_childs_collection ( navi, nsbundle.enums, mself );
this.write_navi_child_error_domains_without_childs_collection ( navi, nsbundle.errordomains, mself );
+ this.write_navi_child_delegates_collection ( navi, nsbundle.delegates, mself );
+ this.write_navi_child_methods_collection ( navi, nsbundle.methods, mself );
+ this.write_navi_child_fields_collection ( navi, nsbundle.fields, mself );
+ this.write_navi_child_constants_collection ( navi, nsbundle.constants, mself );
+
navi.puts ( "</ul>\n" );
navi.puts ( "\t\t\t</div>\n" );
@@ -1304,15 +1312,7 @@
this.write_navi_namespace_bundle ( subnsbundle, mself );
}
-
this.directory_level++;
- foreach ( Constant c in nsbundle.constants ) {
- GLib.FileStream file = GLib.FileStream.open ( nsbundle.path + c.name + "/index.html", "w" );
- this.write_file_header ( file );
- this.write_navi_namespace_bundle_path_navigation ( nsbundle, file, c );
- this.write_constant_content ( file, c, (ConstantHandler)c.parent );
- this.write_file_footer ( file );
- }
foreach ( Delegate del in nsbundle.delegates ) {
GLib.FileStream file = GLib.FileStream.open ( nsbundle.path + del.name + "/index.html", "w" );
this.write_file_header ( file );
@@ -1334,6 +1334,13 @@
this.write_field_content ( file, f, (FieldHandler)f.parent );
this.write_file_footer ( file );
}
+ foreach ( Constant c in nsbundle.constants ) {
+ GLib.FileStream file = GLib.FileStream.open ( nsbundle.path + c.name + "/index.html", "w" );
+ this.write_file_header ( file );
+ this.write_navi_namespace_bundle_path_navigation ( nsbundle, file, c );
+ this.write_constant_content ( file, c, (ConstantHandler)c.parent );
+ this.write_file_footer ( file );
+ }
this.directory_level--;
GLib.FileStream file = GLib.FileStream.open ( nsbundle.path + "index.html", "w" );
@@ -1349,28 +1356,6 @@
this.directory_level--;
}
- private bool copy_file ( string src, string dest ) {
- GLib.FileStream fsrc = GLib.FileStream.open ( src, "rb" );
- GLib.FileStream fdest = GLib.FileStream.open ( dest, "wb" );
- if ( fsrc == null || fdest == null )
- return false;
-
- for ( int c = fsrc.getc() ; !fsrc.eof() ; c = fsrc.getc() ) {
- fdest.putc ( (char)c );
- }
-
- return true;
- }
-
- private void copy_deps ( ) {
- string path = Config.doclet_path + "deps/";
-
- GLib.Dir dir = GLib.Dir.open ( path );
- for ( weak string name = dir.read_name (); name != null ; name = dir.read_name () ) {
- this.copy_file ( path+name, this.settings.path+name );
- }
- }
-
private bool is_depency ( string dep ) {
foreach ( string file in this.settings.files ) {
if ( dep == file )
@@ -1381,14 +1366,15 @@
~HtmlDoclet () {
this.directory_level = 1;
- copy_deps ( );
+
+ copy_directory ( Config.doclet_path + "deps/", this.settings.path );
foreach ( NamespaceBundle nsbundle in this.namespaces ) {
this.write_navi_namespace_bundle ( nsbundle, null );
}
GLib.FileStream sfile = GLib.FileStream.open ( this.settings.path + "index.html", "w" );
- string title = ( this.settings.package_name == null )? "" : this.settings.package_name;
+ string title = ( this.settings.pkg_name == null )? "" : this.settings.pkg_name;
this.write_file_header_template ( sfile, title, 0 );
sfile.printf ( "<h2 class=\"%s\">Namespaces:</h2>\n", css_title );
@@ -1434,7 +1420,15 @@
file.printf ( "<h3 class=\"%s\">Classes:</h3>\n", css_title );
file.printf ( "<ul class=\"%s\">\n", css_inline_navigation );
foreach ( Class subcl in classes ) {
- file.printf ( "\t<li class=\"%s\"><a class=\"%s\" href=\"%s\">%s</a></li>\n", css_inline_navigation_class, css_navi_link, this.get_link(subcl, clh), subcl.name );
+ string name;
+ if ( subcl.is_abstract ) {
+ name = "<i>" + subcl.name + "</i>";
+ }
+ else {
+ name = subcl.name;
+ }
+
+ file.printf ( "\t<li class=\"%s\"><a class=\"%s\" href=\"%s\">%s</a></li>\n", css_inline_navigation_class, css_navi_link, this.get_link(subcl, clh), name );
}
file.puts ( "</ul>\n" );
}
@@ -1593,6 +1587,9 @@
file.printf ( "\t\t\t\t<hr class=\"%s\" />\n", css_headline_hr );
this.write_image_block ( file, iface );
file.printf ( "\t\t\t\t<h2 class=\"%s\">Description:</h2>\n", css_title );
+ file.printf ( "\t\t\t\t<div class=\"%s\">\n\t", css_code_definition );
+ this.langlet.write_interface ( iface, file );
+ file.printf ( "\n\t\t\t\t</div>\n" );
iface.write_comment ( file );
this.write_namespace_note ( file, iface );
this.write_package_note ( file, iface );
@@ -1600,10 +1597,10 @@
this.write_child_classes ( file, iface );
this.write_child_structs ( file, iface );
this.write_child_delegates ( file, iface );
- this.write_child_fields ( file, iface );
- this.write_child_properties ( file, iface );
- this.write_child_signals ( file, iface );
this.write_child_methods ( file, iface );
+ this.write_child_signals ( file, iface );
+ this.write_child_properties ( file, iface );
+ this.write_child_fields ( file, iface );
file.puts ( "\t\t\t</div>\n" );
}
@@ -1622,15 +1619,15 @@
this.write_package_note ( file, cl );
file.printf ( "\n\t\t\t\t<h2 class=\"%s\">Content:</h2>\n", css_title );
this.write_child_construction_methods ( file, cl );
- this.write_child_enums ( file, cl );
this.write_child_classes ( file, cl );
this.write_child_structs ( file, cl );
+ this.write_child_enums ( file, cl );
this.write_child_delegates ( file, cl );
- this.write_child_constants ( file, cl );
- this.write_child_fields ( file, cl );
- this.write_child_properties ( file, cl );
- this.write_child_signals ( file, cl );
this.write_child_methods ( file, cl );
+ this.write_child_signals ( file, cl );
+ this.write_child_properties ( file, cl );
+ this.write_child_fields ( file, cl );
+ this.write_child_constants ( file, cl );
file.puts ( "\t\t\t</div>\n" );
}
@@ -1649,9 +1646,9 @@
this.langlet.write_struct ( stru, file );
file.printf ( "\n\t\t\t\t</div>\n" );
this.write_child_construction_methods ( file, stru );
- this.write_child_constants ( file, stru );
- this.write_child_fields ( file, stru );
this.write_child_methods ( file, stru );
+ this.write_child_fields ( file, stru );
+ this.write_child_constants ( file, stru );
file.puts ( "\t\t\t</div>\n" );
}
@@ -1984,15 +1981,15 @@
// file:
ns.visit_namespaces ( this );
+ ns.visit_classes ( this );
+ ns.visit_interfaces ( this );
+ ns.visit_structs ( this );
ns.visit_enums ( this );
ns.visit_error_domains ( this );
- ns.visit_structs ( this );
- ns.visit_interfaces ( this );
- ns.visit_classes ( this );
ns.visit_delegates ( this );
- ns.visit_constants ( this );
- ns.visit_fields ( this );
ns.visit_methods ( this );
+ ns.visit_fields ( this );
+ ns.visit_constants ( this );
this.current_path = old_path;
this.directory_level--;
@@ -2045,11 +2042,11 @@
this.current_path += stru.name + "/";
var rt = DirUtils.create ( this.current_path, 0777 );
-
- stru.visit_constants ( this );
- stru.visit_fields ( this );
+
stru.visit_construction_methods ( this );
stru.visit_methods ( this );
+ stru.visit_fields ( this );
+ stru.visit_constants ( this );
GLib.FileStream file = GLib.FileStream.open ( this.current_path + "index.html", "w");
this.write_file_header ( file );
@@ -2069,16 +2066,16 @@
this.current_path += cl.name + "/";
var rt = DirUtils.create ( this.current_path, 0777 );
- cl.visit_enums ( this );
+ cl.visit_construction_methods ( this );
cl.visit_classes ( this );
cl.visit_structs ( this );
+ cl.visit_enums ( this );
cl.visit_delegates ( this );
- cl.visit_constants ( this );
- cl.visit_construction_methods ( this );
cl.visit_methods ( this );
- cl.visit_fields ( this );
- cl.visit_properties ( this );
cl.visit_signals ( this );
+ cl.visit_properties ( this );
+ cl.visit_fields ( this );
+ cl.visit_constants ( this );
GLib.FileStream file = GLib.FileStream.open ( this.current_path + "index.html", "w");
this.write_file_header ( file );
@@ -2098,14 +2095,13 @@
this.current_path += iface.name + "/";
var rt = DirUtils.create ( this.current_path, 0777 );
- iface.visit_properties ( this );
+ iface.visit_classes ( this );
+ iface.visit_structs ( this );
iface.visit_delegates ( this );
- iface.visit_signals ( this );
iface.visit_methods ( this );
- iface.visit_structs ( this );
+ iface.visit_signals ( this );
+ iface.visit_properties ( this );
iface.visit_fields ( this );
- iface.visit_structs ( this );
- iface.visit_classes ( this );
GLib.FileStream file = GLib.FileStream.open ( this.current_path + "index.html", "w" );
this.write_file_header ( file );
Modified: trunk/src/doclets/html/linkhelper/helper.vala
==============================================================================
--- trunk/src/doclets/html/linkhelper/helper.vala (original)
+++ trunk/src/doclets/html/linkhelper/helper.vala Sun Nov 2 19:33:58 2008
@@ -114,16 +114,7 @@
return file_name.ndup ( file_name.size() - ".vapi".size() );
}
- if ( this.package_name == null ) {
- this.package_name = this.settings.package_name;
- }
-
- if ( this.package_name == null ) {
- string file_name = this.get_dirname( settings.path );
- this.package_name = file_name; //file_name.ndup ( file_name.size() - ".vala".size() );
- }
-
- return this.package_name;
+ return this.settings.pkg_name;
}
public string get_file_name ( Valadoc.Basic tag ) {
Modified: trunk/src/doclets/valadoc.org/doclet/template.vala
==============================================================================
--- trunk/src/doclets/valadoc.org/doclet/template.vala (original)
+++ trunk/src/doclets/valadoc.org/doclet/template.vala Sun Nov 2 19:33:58 2008
@@ -611,7 +611,13 @@
private void write_navi_entry ( GLib.FileStream file, Basic element, string style, bool link, bool full_name = false ) {
string name;
- if ( element is File ) {
+ if ( element is Class ) {
+ if ( ((Class)element).is_abstract )
+ name = "<i>" + element.name + "</i>";
+ else
+ name = element.name;
+ }
+ else if ( element is File ) {
string path = this.get_file_name ( element );
name = this.get_package_name ( path );
}
@@ -717,15 +723,15 @@
private void write_navi_child_namespaces_inline ( GLib.FileStream file, Namespace ns, Basic mself = null ) {
file.printf ( "<ul class=\"%s\">\n", css_navi );
this.write_navi_child_namespaces_without_childs ( file, ns, mself );
- this.write_navi_child_error_domains_without_childs ( file, ns, mself );
- this.write_navi_child_enums_without_childs ( file, ns, mself );
this.write_navi_child_classes_without_childs ( file, ns, mself );
this.write_navi_child_interfaces_without_childs ( file, ns, mself );
this.write_navi_child_structs_without_childs ( file, ns, mself );
+ this.write_navi_child_enums_without_childs ( file, ns, mself );
+ this.write_navi_child_error_domains_without_childs ( file, ns, mself );
this.write_navi_child_delegates ( file, ns, mself );
- this.write_navi_child_constants ( file, ns, mself );
- this.write_navi_child_fields ( file, ns, mself );
this.write_navi_child_methods ( file, ns, mself );
+ this.write_navi_child_fields ( file, ns, mself );
+ this.write_navi_child_constants ( file, ns, mself );
file.puts ( "</ul>\n" );
}
@@ -736,10 +742,10 @@
private void write_navi_struct_inline ( GLib.FileStream file, Struct stru, Basic mself = null ) {
file.printf ( "<ul class=\"%s\">\n", css_navi );
- this.write_navi_child_constants ( file, stru, mself );
this.write_navi_child_construction_methods ( file, stru, mself );
- this.write_navi_child_fields ( file, stru, mself );
this.write_navi_child_methods ( file, stru, mself );
+ this.write_navi_child_fields ( file, stru, mself );
+ this.write_navi_child_constants ( file, stru, mself );
file.puts ( "</ul>\n" );
}
@@ -751,10 +757,10 @@
private void write_navi_interface_inline ( GLib.FileStream file, Interface iface, Basic mself = null ) {
file.printf ( "<ul class=\"%s\">\n", css_navi );
this.write_navi_child_delegates ( file, iface, mself );
- this.write_navi_child_fields ( file, iface, mself );
- this.write_navi_child_properties ( file, iface, mself );
this.write_navi_child_methods ( file, iface, mself );
this.write_navi_child_signals ( file, iface, mself );
+ this.write_navi_child_properties ( file, iface, mself );
+ this.write_navi_child_fields ( file, iface, mself );
file.puts ( "</ul>\n" );
}
@@ -799,16 +805,16 @@
private void write_navi_class_inline ( GLib.FileStream file, Class cl, Basic mself = null ) {
file.printf ( "<ul class=\"%s\">\n", css_navi );
- this.write_navi_child_enums_without_childs ( file, cl, mself );
+ this.write_navi_child_construction_methods ( file, cl, mself );
this.write_navi_child_classes_without_childs ( file, cl, mself );
this.write_navi_child_structs_without_childs ( file, cl, mself );
+ this.write_navi_child_enums_without_childs ( file, cl, mself );
this.write_navi_child_delegates ( file, cl, mself );
- this.write_navi_child_constants ( file, cl, mself );
- this.write_navi_child_construction_methods ( file, cl, mself );
- this.write_navi_child_fields ( file, cl, mself );
- this.write_navi_child_properties ( file, cl, mself );
this.write_navi_child_methods ( file, cl, mself );
this.write_navi_child_signals ( file, cl, mself );
+ this.write_navi_child_properties ( file, cl, mself );
+ this.write_navi_child_fields ( file, cl, mself );
+ this.write_navi_child_constants ( file, cl, mself );
file.puts ( "</ul>\n" );
}
@@ -1197,15 +1203,16 @@
foreach ( NamespaceBundle nsb in nsbundle.subnamespaces ) {
this.write_navi_entry_html_template_with_link ( navi, css_navi_namespace, nsb.link, (nsb.name == null)? "Global Namespace" : nsb.name );
}
+
this.write_navi_child_classes_without_childs_collection ( navi, nsbundle.classes, mself );
- this.write_navi_child_methods_collection ( navi, nsbundle.methods, mself );
- this.write_navi_child_fields_collection ( navi, nsbundle.fields, mself );
- this.write_navi_child_constants_collection ( navi, nsbundle.constants, mself );
- this.write_navi_child_structs_without_childs_collection ( navi, nsbundle.structs, mself );
- this.write_navi_child_delegates_collection ( navi, nsbundle.delegates, mself );
this.write_navi_child_interfaces_without_childs_collection ( navi, nsbundle.interfaces, mself );
+ this.write_navi_child_structs_without_childs_collection ( navi, nsbundle.structs, mself );
this.write_navi_child_enums_without_childs_collection ( navi, nsbundle.enums, mself );
this.write_navi_child_error_domains_without_childs_collection ( navi, nsbundle.errordomains, mself );
+ this.write_navi_child_delegates_collection ( navi, nsbundle.delegates, mself );
+ this.write_navi_child_methods_collection ( navi, nsbundle.methods, mself );
+ this.write_navi_child_fields_collection ( navi, nsbundle.fields, mself );
+ this.write_navi_child_constants_collection ( navi, nsbundle.constants, mself );
navi.puts ( "</ul>\n" );
}
@@ -1214,10 +1221,6 @@
this.write_navi_namespace_bundle ( subnsbundle );
}
- foreach ( Constant c in nsbundle.constants ) {
- GLib.FileStream navi = GLib.FileStream.open ( nsbundle.path + c.name + "/navi.html", "w" );
- this.write_navi_namespace_bundle_path_navigation ( nsbundle, navi, c );
- }
foreach ( Delegate del in nsbundle.delegates ) {
GLib.FileStream navi = GLib.FileStream.open ( nsbundle.path + del.name + "/navi.html", "w" );
this.write_navi_namespace_bundle_path_navigation ( nsbundle, navi, del );
@@ -1230,6 +1233,11 @@
GLib.FileStream navi = GLib.FileStream.open ( nsbundle.path + f.name + "/navi.html", "w" );
this.write_navi_namespace_bundle_path_navigation ( nsbundle, navi, f );
}
+ foreach ( Constant c in nsbundle.constants ) {
+ GLib.FileStream navi = GLib.FileStream.open ( nsbundle.path + c.name + "/navi.html", "w" );
+ this.write_navi_namespace_bundle_path_navigation ( nsbundle, navi, c );
+ }
+
GLib.FileStream navi = GLib.FileStream.open ( nsbundle.path + "navi.html", "w" );
this.write_navi_namespace_bundle_path_navigation ( nsbundle, navi, mself );
@@ -1279,18 +1287,17 @@
file = null;
}
-
// file:
ns.visit_namespaces ( this );
+ ns.visit_classes ( this );
+ ns.visit_interfaces ( this );
+ ns.visit_structs ( this );
ns.visit_enums ( this );
ns.visit_error_domains ( this );
- ns.visit_structs ( this );
- ns.visit_interfaces ( this );
- ns.visit_classes ( this );
ns.visit_delegates ( this );
- ns.visit_constants ( this );
- ns.visit_fields ( this );
ns.visit_methods ( this );
+ ns.visit_fields ( this );
+ ns.visit_constants ( this );
this.current_path = old_path;
}
@@ -1301,7 +1308,13 @@
file.printf ( "<h3 class=\"%s\">Classes:</h3>\n", css_title );
file.printf ( "<ul class=\"%s\">\n", css_inline_navigation );
foreach ( Class subcl in classes ) {
- file.printf ( "\t<li class=\"%s\"><a class=\"%s\" href=\"%s\">%s</a></li>\n", css_inline_navigation_class, css_navi_link, this.get_link(subcl), subcl.name );
+ string name;
+ if ( subcl.is_abstract )
+ name = "<i>" + subcl.name + "</i>";
+ else
+ name = subcl.name;
+
+ file.printf ( "\t<li class=\"%s\"><a class=\"%s\" href=\"%s\">%s</a></li>\n", css_inline_navigation_class, css_navi_link, this.get_link(subcl), name );
}
file.puts ( "</ul>\n" );
}
@@ -1461,6 +1474,11 @@
this.write_image_block ( file, iface );
file.printf ( "<h2 class=\"%s\">Description:</h2>\n", css_title );
+
+ file.printf ( "<div class=\"%s\">\n\t", css_code_definition );
+ this.langlet.write_interface ( iface, file );
+ file.printf ( "\n</div>\n" );
+
iface.write_comment ( file );
this.write_namespace_note ( file, iface );
this.write_package_note ( file, iface );
@@ -1469,10 +1487,10 @@
this.write_child_classes ( file, iface );
this.write_child_structs ( file, iface );
this.write_child_delegates ( file, iface );
- this.write_child_fields ( file, iface );
- this.write_child_properties ( file, iface );
- this.write_child_signals ( file, iface );
this.write_child_methods ( file, iface );
+ this.write_child_signals ( file, iface );
+ this.write_child_properties ( file, iface );
+ this.write_child_fields ( file, iface );
}
public override void visit_interface ( Interface iface ) {
@@ -1480,14 +1498,13 @@
this.current_path += iface.name + "/";
var rt = DirUtils.create ( this.current_path, 0777 );
- iface.visit_properties ( this );
+ iface.visit_classes ( this );
+ iface.visit_structs ( this );
iface.visit_delegates ( this );
- iface.visit_signals ( this );
iface.visit_methods ( this );
- iface.visit_structs ( this );
+ iface.visit_signals ( this );
+ iface.visit_properties ( this );
iface.visit_fields ( this );
- iface.visit_structs ( this );
- iface.visit_classes ( this );
GLib.FileStream cname = GLib.FileStream.open ( this.current_path + "cname", "w" );
cname.puts ( iface.get_cname() );
@@ -1520,16 +1537,17 @@
this.write_namespace_note ( file, cl );
this.write_package_note ( file, cl );
file.printf ( "\n<h2 class=\"%s\">Content:</h2>\n", css_title );
+
this.write_child_construction_methods ( file, cl );
- this.write_child_enums ( file, cl );
this.write_child_classes ( file, cl );
this.write_child_structs ( file, cl );
+ this.write_child_enums ( file, cl );
this.write_child_delegates ( file, cl );
- this.write_child_constants ( file, cl );
- this.write_child_fields ( file, cl );
- this.write_child_properties ( file, cl );
- this.write_child_signals ( file, cl );
this.write_child_methods ( file, cl );
+ this.write_child_signals ( file, cl );
+ this.write_child_properties ( file, cl );
+ this.write_child_fields ( file, cl );
+ this.write_child_constants ( file, cl );
}
public override void visit_class ( Class cl ) {
@@ -1537,16 +1555,16 @@
this.current_path += cl.name + "/";
var rt = DirUtils.create ( this.current_path, 0777 );
- cl.visit_enums ( this );
+ cl.visit_construction_methods ( this );
cl.visit_classes ( this );
cl.visit_structs ( this );
+ cl.visit_enums ( this );
cl.visit_delegates ( this );
- cl.visit_constants ( this );
- cl.visit_construction_methods ( this );
cl.visit_methods ( this );
- cl.visit_fields ( this );
- cl.visit_properties ( this );
cl.visit_signals ( this );
+ cl.visit_properties ( this );
+ cl.visit_fields ( this );
+ cl.visit_constants ( this );
GLib.FileStream navi = GLib.FileStream.open ( this.current_path + "navi.html", "w" );
this.write_navi_class ( navi, cl );
@@ -1580,20 +1598,20 @@
file.printf ( "\n</div>\n" );
this.write_child_construction_methods ( file, stru );
- this.write_child_constants ( file, stru );
- this.write_child_fields ( file, stru );
this.write_child_methods ( file, stru );
+ this.write_child_fields ( file, stru );
+ this.write_child_constants ( file, stru );
}
public override void visit_struct ( Struct stru ) {
string old_path = this.current_path;
this.current_path += stru.name + "/";
var rt = DirUtils.create ( this.current_path, 0777 );
-
- stru.visit_constants ( this );
- stru.visit_fields ( this );
+
stru.visit_construction_methods ( this );
stru.visit_methods ( this );
+ stru.visit_fields ( this );
+ stru.visit_constants ( this );
GLib.FileStream navi = GLib.FileStream.open ( this.current_path + "navi.html", "w" );
this.write_navi_struct ( navi, stru );
Modified: trunk/src/doclets/valadoc.org/linkhelper/helper.vala
==============================================================================
--- trunk/src/doclets/valadoc.org/linkhelper/helper.vala (original)
+++ trunk/src/doclets/valadoc.org/linkhelper/helper.vala Sun Nov 2 19:33:58 2008
@@ -110,12 +110,7 @@
return file_name.ndup ( file_name.size() - ".vapi".size() );
}
- if ( this.package_name == null ) {
- string file_name = this.get_dirname( settings.path );
- this.package_name = file_name; //file_name.ndup ( file_name.size() - ".vala".size() );
- }
-
- return this.package_name;
+ return this.settings.pkg_name;
}
public string get_file_name ( Valadoc.Basic tag ) {
Modified: trunk/src/libvaladoc/doctree.vala
==============================================================================
--- trunk/src/libvaladoc/doctree.vala (original)
+++ trunk/src/libvaladoc/doctree.vala Sun Nov 2 19:33:58 2008
@@ -23,9 +23,30 @@
using Gee;
-//ported from glibc
-
namespace Valadoc {
+ public bool copy_file ( string src, string dest ) {
+ GLib.FileStream fsrc = GLib.FileStream.open ( src, "rb" );
+ GLib.FileStream fdest = GLib.FileStream.open ( dest, "wb" );
+ if ( fsrc == null || fdest == null )
+ return false;
+
+ for ( int c = fsrc.getc() ; !fsrc.eof() ; c = fsrc.getc() ) {
+ fdest.putc ( (char)c );
+ }
+
+ return true;
+ }
+
+ public void copy_directory ( string src, string dest ) {
+ string _src = ( src.has_suffix ( "/" ) )? src : src + "/";
+ string _dest = ( dest.has_suffix ( "/" ) )? dest : dest + "/";
+
+ GLib.Dir dir = GLib.Dir.open ( _src );
+ for ( weak string name = dir.read_name (); name != null ; name = dir.read_name () ) {
+ copy_file ( _src+name, _dest+name );
+ }
+ }
+
public string realpath (string name) {
string rpath;
@@ -144,7 +165,7 @@
return file_name.ndup ( file_name.size() - ".vapi".size() );
}
- return this.settings.package_name;
+ return this.settings.pkg_name;
}
}
Modified: trunk/src/libvaladoc/drawer.vala
==============================================================================
--- trunk/src/libvaladoc/drawer.vala (original)
+++ trunk/src/libvaladoc/drawer.vala Sun Nov 2 19:33:58 2008
@@ -110,6 +110,7 @@
if ( node == null ) {
node = g.node ( name );
node.set_safe ( "shape", "box", "" );
+ node.set_safe ( "fontname", "Times", "" );
}
if ( parent != null ) {
@@ -126,6 +127,7 @@
if ( node == null ) {
node = g.node ( name );
node.set_safe ( "shape", "box", "" );
+ node.set_safe ( "fontname", "Times", "" );
}
if ( parent != null ) {
@@ -141,8 +143,13 @@
weak Graphviz.Node? node = g.find_node ( name );
if ( node == null ) {
node = g.node ( name );
- node.set_safe ( "shape", "box", "" );
node.set_safe ( "style", "bold", "" );
+ node.set_safe ( "shape", "box", "" );
+
+ if ( cl.is_abstract )
+ node.set_safe ( "fontname", "Times-Italic", "" );
+ else
+ node.set_safe ( "fontname", "Times", "" );
}
if ( parent != null ) {
Modified: trunk/src/libvaladoc/settings.vala
==============================================================================
--- trunk/src/libvaladoc/settings.vala (original)
+++ trunk/src/libvaladoc/settings.vala Sun Nov 2 19:33:58 2008
@@ -24,7 +24,8 @@
public Gee.ArrayList<string> files;
private string rpath;
public string path = "documentation/";
- public string package_name = null;
+ public string pkg_name = null;
+ public string pkg_version;
public bool _private = false;
public bool _protected = false;
public bool with_deps = false;
@@ -43,6 +44,7 @@
return this.rpath;
}
+ // wtf?
public bool application {
get {
foreach ( string path in this.files ) {
@@ -53,6 +55,7 @@
}
}
+ // remove!
public bool to_doc ( string name ) {
if ( with_deps == true )
return true;
Modified: trunk/src/valadoc/valadoc.vala
==============================================================================
--- trunk/src/valadoc/valadoc.vala (original)
+++ trunk/src/valadoc/valadoc.vala Sun Nov 2 19:33:58 2008
@@ -30,10 +30,11 @@
public class ValaDoc : Object {
- private static string basedir;
- private static string directory;
- private static string xmlsource;
- private static string package_name;
+ private static string basedir = null;
+ private static string directory = null;
+ private static string xmlsource = null;
+ private static string pkg_name = null;
+ private static string pkg_version = null;
private static bool add_documentation = false;
private static bool add_inherited = false;
@@ -48,6 +49,7 @@
private static bool disable_non_null = false;
private static bool disable_checking;
+
[NoArrayLength ()]
private static string[] vapi_directories;
[NoArrayLength ()]
@@ -73,7 +75,7 @@
//{ "library", 0, 0, OptionArg.STRING, out library, "Library name", "NAME" },
//{ "basedir", 'b', 0, OptionArg.FILENAME, out basedir, "Base source directory", "DIRECTORY" },
{ "directory", 'o', 0, OptionArg.FILENAME, out directory, "Output directory", "DIRECTORY" },
- { "package-name", 0, 0, OptionArg.FILENAME, out package_name, "Package name", "DIRECTORY" },
+// { "package-name", 0, 0, OptionArg.FILENAME, out package_name, "Package name", "DIRECTORY" },
{ "protected", 0, 0, OptionArg.NONE, ref _protected, "Adds protected elements to documentation", null },
{ "private", 0, 0, OptionArg.NONE, ref _private, "Adds private elements to documentation", null },
{ "inherit", 0, 0, OptionArg.NONE, ref add_inherited, "Adds inherited elements to a class", null },
@@ -84,7 +86,9 @@
"Enable experimentalenhancements for non-null types", null },
{ "", 0, 0, OptionArg.FILENAME_ARRAY, out tsources, null, "FILE..." },
{ "doclet", 0, 0, OptionArg.FILENAME, ref pluginpath, "plugin", "DIRECTORY" },
- { "xml", 0, 0, OptionArg.FILENAME, ref xmlsource, "xml", "DIRECTORY" },
+ { "package-name", 0, 0, OptionArg.STRING, ref pkg_name, "package name", "DIRECTORY" },
+ { "package-version", 0, 0, OptionArg.STRING, ref pkg_version, "package version", "DIRECTORY" },
+// { "xml", 0, 0, OptionArg.FILENAME, ref xmlsource, "xml", "DIRECTORY" },
{ null }
};
@@ -110,7 +114,7 @@
if (package_path == null) {
return false;
}
-
+
context.add_package (pkg);
context.add_source_file (new SourceFile (context, package_path, true));
@@ -194,8 +198,8 @@
if ( tsources != null ) {
foreach ( string str in this.tsources ) {
- string rpath = this.realpath ( str );
- if ( str.has_suffix ( ".vala" ) )
+ string rpath = realpath ( str );
+ if ( str.has_suffix ( ".vala" ) || str.has_suffix ( ".gs" ) )
this.sources.add ( str );
else
this.packages.add ( str );
@@ -374,23 +378,41 @@
return (Doclet)GLib.Object.new (doclettype);
}
- private bool check_package_name () {
- if ( package_name == null )
+ private bool check_pkg_name () {
+ if ( pkg_name == null )
return true;
- if ( package_name == "glib-2.0" )
+ if ( pkg_name == "glib-2.0" )
return false;
foreach (string package in this.packages ) {
- if ( package_name == package )
+ if ( pkg_name == package )
return false;
}
return true;
}
+
+ private string get_pkg_name ( ) {
+ if ( this.pkg_name == null ) {
+ if ( this.directory.has_suffix ( "/" ) )
+ pkg_name = GLib.Path.get_dirname ( this.directory );
+ else
+ pkg_name = GLib.Path.get_basename ( this.directory );
+ }
+
+ return this.pkg_name;
+ }
+
private int run ( ) {
+ if ( !check_pkg_name () ) {
+ Report.error (null, "Invalid package name." );
+ }
+
var settings = new Valadoc.Settings ( );
- settings.package_name = this.package_name;
+ settings.pkg_name = this.get_pkg_name ( );
+ settings.pkg_version = this.pkg_version;
+
settings.add_inherited = this.add_inherited;
settings.files = this.sort_sources ( );
settings._protected = this._protected;
@@ -398,7 +420,6 @@
settings._private = this._private;
settings.path = this.directory;
-
var context = new Vala.CodeContext();
context.library = this.library;
context.memory_management = false;
@@ -429,10 +450,6 @@
context.thread = false;
context.save_temps = false;
- if ( !check_package_name () ) {
- Report.error (null, "Invalid package name." );
- }
-
if (!add_package (context, "glib-2.0")) {
Report.error (null, "glib-2.0 not found in specified Vala API directories");
}
@@ -530,8 +547,8 @@
if ( reporter.errors > 0 )
return quit ();
- //////////////////////////// XML //////////////////////////
+/* //////////////////////////// XML //////////////////////////
if ( xmlsource != null ) {
var xml = new MergeExternalDocumentation ( doctree );
bool tmp = xml.parse ( xmlsource );
@@ -540,12 +557,12 @@
return 1;
}
}
-
+*/
doctree.parse_comments ( docparser );
if ( reporter.errors > 0 )
return 1;
- ///////////////////////////////////////////////////////////
+
doclet.initialisation ( settings );
@@ -604,8 +621,6 @@
else {
if ( !pluginpath.has_suffix ( "/" ) )
pluginpath = pluginpath + "/";
-
- stdout.printf ( ">%s<\n", pluginpath );
}
var valadoc = new ValaDoc( );
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
