Plugins-Commits May 2010

plugins-commits@lists.geany.org

7 participants
98 discussions

SF.net SVN: geany-plugins:[1387] trunk/geany-plugins/wscript
by eht16＠users.sourceforge.net 23 May '10

23 May '10

Revision: 1387 http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1387&view=rev Author: eht16 Date: 2010-05-23 10:23:15 +0000 (Sun, 23 May 2010) Log Message: ----------- Add GeanyGenDoc plugin to the Waf build system Modified Paths: -------------- trunk/geany-plugins/wscript Modified: trunk/geany-plugins/wscript =================================================================== --- trunk/geany-plugins/wscript 2010-05-23 07:50:15 UTC (rev 1386) +++ trunk/geany-plugins/wscript 2010-05-23 10:23:15 UTC (rev 1387) @@ -78,6 +78,7 @@ Plugin('codenav', None, [ 'codenav/src' ]), Plugin('geanydoc', None, [ 'geanydoc/src' ]), Plugin('geanyextrasel', None, [ 'geanyextrasel/src' ]), + Plugin('geanygendoc', None, [ 'geanygendoc/src' ], [ [ 'ctpl', '0.2', True ] ]), Plugin('geanyinsertnum', None, [ 'geanyinsertnum/src' ]), Plugin('geanylatex', None, [ 'geanylatex/src']), Plugin('geanylipsum', None, [ 'geanylipsum/src']), @@ -419,6 +420,19 @@ bld.install_files('%s/geany-plugins/geanylua/work' % datadir, 'geanylua/examples/work/*.lua') + def build_gendoc(bld): + # install docs + docdir = '${G_PREFIX}/doc/plugins/geanygendoc/help' \ + if is_win32 else '${DOCDIR}/geanygendoc/help' + if os.path.exists('geanygendoc/docs/help/manual.html'): + bld.install_files(docdir, 'geanygendoc/docs/help/manual.html') + bld.install_files(docdir, 'geanygendoc/docs/help/manual.rst') + # install examples (Waf doesn't support installing files recursively, yet) + datadir = '${G_PREFIX}/share/' if is_win32 else '${DATADIR}' + bld.install_files('%s/geany-plugins/geanygendoc/filetypes' % datadir, \ + 'geanygendoc/data/filetypes/*.conf') + + def build_debug(bld, p, libs): bld.new_task_gen( features = 'cc cprogram', @@ -454,6 +468,9 @@ if p.name == 'geanylua': build_lua(bld, p, libs) # build additional lib for the lua plugin + if p.name == 'geanygendoc': + build_gendoc(bld) # install data files + if p.name == 'geanygdb': build_debug(bld, p, libs) # build additional binary for the debug plugin This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

1 0

SF.net SVN: geany-plugins:[1386] trunk
by frlan＠users.sourceforge.net 23 May '10

23 May '10

Revision: 1386 http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1386&view=rev Author: frlan Date: 2010-05-23 07:50:15 +0000 (Sun, 23 May 2010) Log Message: ----------- GeanyLaTeX: Remove code block which has been never executed for a long time Modified Paths: -------------- trunk/geany-plugins/geanylatex/src/bibtex.c trunk/geanylatex/src/bibtex.c Modified: trunk/geany-plugins/geanylatex/src/bibtex.c =================================================================== --- trunk/geany-plugins/geanylatex/src/bibtex.c 2010-05-23 00:57:37 UTC (rev 1385) +++ trunk/geany-plugins/geanylatex/src/bibtex.c 2010-05-23 07:50:15 UTC (rev 1386) @@ -22,21 +22,7 @@ #include "bibtex.h" #include "reftex.h" -#if 0 -static int get_entry_pos(char *str) -{ - int i; - if(str != NULL) { - for (i = 0; i < N_ENTRIES; i++) { - if (utils_str_casecmp(str, label_entry[i]) == 0) - return i; - } - } - return -1; -} -#endif - void glatex_insert_bibtex_entry(G_GNUC_UNUSED GtkMenuItem * menuitem, gpointer gdata) { Modified: trunk/geanylatex/src/bibtex.c =================================================================== --- trunk/geanylatex/src/bibtex.c 2010-05-23 00:57:37 UTC (rev 1385) +++ trunk/geanylatex/src/bibtex.c 2010-05-23 07:50:15 UTC (rev 1386) @@ -22,21 +22,7 @@ #include "bibtex.h" #include "reftex.h" -#if 0 -static int get_entry_pos(char *str) -{ - int i; - if(str != NULL) { - for (i = 0; i < N_ENTRIES; i++) { - if (utils_str_casecmp(str, label_entry[i]) == 0) - return i; - } - } - return -1; -} -#endif - void glatex_insert_bibtex_entry(G_GNUC_UNUSED GtkMenuItem * menuitem, gpointer gdata) { This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

1 0

SF.net SVN: geany-plugins:[1385] trunk/geany-plugins/geanygendoc
by colombanw＠users.sourceforge.net 23 May '10

23 May '10

Revision: 1385 http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1385&view=rev Author: colombanw Date: 2010-05-23 00:57:37 +0000 (Sun, 23 May 2010) Log Message: ----------- GeanyGenDoc: Install plain-text manual together with the HTML version Modified Paths: -------------- trunk/geany-plugins/geanygendoc/ChangeLog trunk/geany-plugins/geanygendoc/docs/help/Makefile.am Modified: trunk/geany-plugins/geanygendoc/ChangeLog =================================================================== --- trunk/geany-plugins/geanygendoc/ChangeLog 2010-05-23 00:57:09 UTC (rev 1384) +++ trunk/geany-plugins/geanygendoc/ChangeLog 2010-05-23 00:57:37 UTC (rev 1385) @@ -5,6 +5,8 @@ * ChangeLog, docs/help/Makefile.am, docs/help/manual.html: Add the generated HTML manual under VCS for the users not to need docutils. + * ChangeLog, docs/help/Makefile.am: + Install plain-text manual together with the HTML version. 2010-05-22 Colomban Wendling <ban(at)herbesfolles(dot)org> Modified: trunk/geany-plugins/geanygendoc/docs/help/Makefile.am =================================================================== --- trunk/geany-plugins/geanygendoc/docs/help/Makefile.am 2010-05-23 00:57:09 UTC (rev 1384) +++ trunk/geany-plugins/geanygendoc/docs/help/Makefile.am 2010-05-23 00:57:37 UTC (rev 1385) @@ -9,7 +9,8 @@ manual.html if ENABLE_GEANYGENDOC -plugindoc_DATA = manual.html +plugindoc_DATA = manual.rst \ + manual.html if BUILD_RST manual.html: manual.rst manual.css This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

1 0

SF.net SVN: geany-plugins:[1384] trunk/geany-plugins/geanygendoc
by colombanw＠users.sourceforge.net 23 May '10

23 May '10

Revision: 1384 http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1384&view=rev Author: colombanw Date: 2010-05-23 00:57:09 +0000 (Sun, 23 May 2010) Log Message: ----------- GeanyGenDoc: Also distribute manual in HTML format Add the generated HTML manual under VCS for the users not to need docutils. Modified Paths: -------------- trunk/geany-plugins/geanygendoc/ChangeLog trunk/geany-plugins/geanygendoc/docs/help/Makefile.am Added Paths: ----------- trunk/geany-plugins/geanygendoc/docs/help/manual.html Modified: trunk/geany-plugins/geanygendoc/ChangeLog =================================================================== --- trunk/geany-plugins/geanygendoc/ChangeLog 2010-05-22 23:19:51 UTC (rev 1383) +++ trunk/geany-plugins/geanygendoc/ChangeLog 2010-05-23 00:57:09 UTC (rev 1384) @@ -1,3 +1,12 @@ +2010-05-23 Colomban Wendling <ban(at)herbesfolles(dot)org> + + * ChangeLog, Makefile.am, data/filetypes/Makefile.am, src/ggd-utils.c: + Temporary hackish fix for data installation. + * ChangeLog, docs/help/Makefile.am, docs/help/manual.html: + Add the generated HTML manual under VCS for the users not to need + docutils. + + 2010-05-22 Colomban Wendling <ban(at)herbesfolles(dot)org> * src/ggd-plugin.c: @@ -7,8 +16,6 @@ Add an entry in the TODO-list * [All] Import into Geany-Plugins. - * ChangeLog, Makefile.am, data/filetypes/Makefile.am, src/ggd-utils.c: - Temporary hackish fix for data installation. 2010-05-21 Colomban Wendling <ban(at)herbesfolles(dot)org> Modified: trunk/geany-plugins/geanygendoc/docs/help/Makefile.am =================================================================== --- trunk/geany-plugins/geanygendoc/docs/help/Makefile.am 2010-05-22 23:19:51 UTC (rev 1383) +++ trunk/geany-plugins/geanygendoc/docs/help/Makefile.am 2010-05-23 00:57:09 UTC (rev 1384) @@ -1,19 +1,17 @@ if ENABLE_GEANYGENDOC include $(top_srcdir)/build/vars.docs.mk plugin = geanygendoc -AIXFILES= endif ENABLE_GEANYGENDOC EXTRA_DIST = manual.rst \ manual.css \ - html4css1.css + html4css1.css \ + manual.html if ENABLE_GEANYGENDOC -if BUILD_RST plugindoc_DATA = manual.html -EXTRA_DIST += manual.html - +if BUILD_RST manual.html: manual.rst manual.css $(AM_V_GEN) $(RST2HTML) -d --strict --stylesheet-path manual.css $< $@ endif BUILD_RST Added: trunk/geany-plugins/geanygendoc/docs/help/manual.html =================================================================== --- trunk/geany-plugins/geanygendoc/docs/help/manual.html (rev 0) +++ trunk/geany-plugins/geanygendoc/docs/help/manual.html 2010-05-23 00:57:09 UTC (rev 1384) @@ -0,0 +1,602 @@ +<?xml version="1.0" encoding="utf-8" ?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<meta name="generator" content="Docutils 0.6: http://docutils.sourceforge.net/" /> +<title>GeanyGenDoc User Manual</title> +<style type="text/css"> + +/* +:Author: Colomban Wendling +:Contact: ban(a)herbesfolles.org +:Copyright: This stylesheet has been placed in the public domain. + +Stylesheet for use with Docutils. +*/ + +@import url(html4css1.css); + +html { + background-color: #eeeeec; + color: #2e3436; + font-family: bitstream vera sans, sans-serif; + margin: 0 1em; +} + + +h1, h2, h3, h4, h5, h6, p.topic-title { + font-family: georgia, times new roman, times, serif; +} + +h2.subtitle { + font-style: italic; + font-weight: normal; +} + +p, dd { + text-align: justify; +} + +.literal-block, +.literal { + background: #fff; +} +.literal-block { + border: 1px solid #babdb6; + padding: 1px 2px; +} +h1 .literal, h2 .literal, h3 .literal, h4 .literal, h5 .literal, h6 .literal +p.topic-title .literal { + background: inherit; + text-align: left; +} + + +.footnote-reference { + vertical-align: super; + font-size: 75%; +} + + +a { text-decoration: none; } +a:hover { text-decoration: underline } +a:link { color: #204a87; } +a:visited { color: #5c3566; } + +h1 a, h1 a:hover, h1 a:link, h1 a:visited, +h2 a, h2 a:hover, h2 a:link, h2 a:visited, +h3 a, h3 a:hover, h3 a:link, h3 a:visited, +h4 a, h4 a:hover, h4 a:link, h4 a:visited, +h5 a, h5 a:hover, h5 a:link, h5 a:visited, +h6 a, h6 a:hover, h6 a:link, h6 a:visited, +p.topic-title a, p.topic-title a:hover, p.topic-title a:link, p.topic-title a:visited +{ + text-decoration: none; + color: inherit; +} + +</style> +</head> +<body> +<div class="document" id="geanygendoc-user-manual"> +<h1 class="title">GeanyGenDoc User Manual</h1> +<h2 class="subtitle" id="a-handy-hand-guide-for-the-lazy-documenter-in-you">A handy hand guide for the lazy documenter in you</h2> + +<div class="section" id="introduction"> +<h1><a class="toc-backref" href="#id4">Introduction</a></h1> +<p>First of all, welcome to this manual. Then, what is GeanyGenDoc? It is a +plug-in for Geany as you might have noticed; but what is it meant to do? +Basically, it generates and inserts text chunks, particularly from document's +symbols. Its goal is to ease writing documentation for the good.</p> +<div class="contents topic" id="contents"> +<p class="topic-title first">Contents</p> +<ul class="simple"> +<li><a class="reference internal" href="#introduction" id="id4">Introduction</a></li> +<li><a class="reference internal" href="#design" id="id5">Design</a></li> +<li><a class="reference internal" href="#syntax" id="id6">Syntax</a><ul> +<li><a class="reference internal" href="#key-value-pairs" id="id7">Key-Value pairs</a></li> +<li><a class="reference internal" href="#naming" id="id8">Naming</a></li> +<li><a class="reference internal" href="#comments" id="id9">Comments</a></li> +<li><a class="reference internal" href="#value-types" id="id10">Value types</a></li> +</ul> +</li> +<li><a class="reference internal" href="#file-types" id="id11">File types</a><ul> +<li><a class="reference internal" href="#the-settings-group" id="id12">The <tt class="docutils literal">settings</tt> group</a></li> +<li><a class="reference internal" href="#the-doctypes-group" id="id13">The <tt class="docutils literal">doctypes</tt> group</a></li> +</ul> +</li> +<li><a class="reference internal" href="#documentation-types" id="id14">Documentation types</a><ul> +<li><a class="reference internal" href="#short-example" id="id15">Short example</a></li> +</ul> +</li> +<li><a class="reference internal" href="#rules-the-cool-thing" id="id16">Rules: the cool thing</a><ul> +<li><a class="reference internal" href="#type-hierarchy" id="id17">Type hierarchy</a><ul> +<li><a class="reference internal" href="#known-types" id="id18">Known types</a></li> +</ul> +</li> +<li><a class="reference internal" href="#rule-settings" id="id19">Rule settings</a></li> +</ul> +</li> +<li><a class="reference internal" href="#user-interface-in-geany" id="id20">User interface in Geany</a><ul> +<li><a class="reference internal" href="#menus" id="id21">Menus</a><ul> +<li><a class="reference internal" href="#editor-s-pop-up-menu" id="id22">Editor's pop-up menu</a></li> +<li><a class="reference internal" href="#tools-menu" id="id23">Tools menu</a></li> +</ul> +</li> +<li><a class="reference internal" href="#preferences-dialog" id="id24">Preferences dialog</a></li> +</ul> +</li> +<li><a class="reference internal" href="#miscellaneous" id="id25">Miscellaneous</a><ul> +<li><a class="reference internal" href="#configuration-directories" id="id26">Configuration directories</a></li> +</ul> +</li> +<li><a class="reference internal" href="#appendix" id="id27">Appendix</a><ul> +<li><a class="reference internal" href="#configuration-syntax-summary" id="id28">Configuration syntax summary</a></li> +</ul> +</li> +</ul> +</div> +</div> +<div class="section" id="design"> +<h1><a class="toc-backref" href="#id5">Design</a></h1> +<p>GeanyGenDoc has an extensible design based on three points: file type, +documentation type and rules.</p> +<dl class="docutils"> +<dt><a class="reference internal" href="#file-types">File type</a></dt> +<dd>The file type determines which configuration applies to which document. For +example, the "c" file type corresponds to C source, and so on.</dd> +<dt><a class="reference internal" href="#documentation-types">Documentation type</a></dt> +<dd>A documentation type is an arbitrary name for a set of rules. The goal of +documentation types is to allow different set of rules to be defined for each +file type. +One might want to have separate rules to generate for example <a class="reference external" href="http://www.doxygen.org">Doxygen</a> +and <a class="reference external" href="http://www.gtk.org/gtk-doc/">Gtk-Doc</a> documentation from C sources. She should then create two +documentation types in the C <a class="reference internal" href="#file-types">file type configuration file</a>, such as +"doxygen" and "gtkdoc".</dd> +<dt><a class="reference internal" href="#rules-the-cool-thing">Rule</a></dt> +<dd>A rule is a group of settings controlling how a documentation comment is +generated. For example, it can define a template, describe how to handle +particular imbrications and so on.</dd> +</dl> +</div> +<div class="section" id="syntax"> +<h1><a class="toc-backref" href="#id6">Syntax</a></h1> +<div class="section" id="key-value-pairs"> +<h2><a class="toc-backref" href="#id7">Key-Value pairs</a></h2> +<p>The syntax used by the configuration files is an extended key-value tree +definition based on common concepts (trees, string literals, semicolon-ended +values, etc.).</p> +<p>The key-value syntax is as follows:</p> +<pre class="literal-block"> +key = value +</pre> +<p>where value is either a semicolon-ended single value:</p> +<pre class="literal-block"> +value; +</pre> +<p>or a brace-surrounded list of key-value pairs that use the same syntax again:</p> +<pre class="literal-block"> +{ + key1 = value1 + key2 = value2 +} +</pre> +<p>Here a little example of the <em>syntax</em> (not any actual configuration example):</p> +<pre class="literal-block"> +key1 = value1; +key2 = { + sub-key1 = sub-value1; + sub-key2 = { + sub-sub-key1 = sub-sub-value1; + } +} +</pre> +</div> +<div class="section" id="naming"> +<h2><a class="toc-backref" href="#id8">Naming</a></h2> +<p>Key-value pairs are often referred as <em>group</em> when they are meant to have +multiple values and as <em>setting</em> when they have a single value.</p> +</div> +<div class="section" id="comments"> +<h2><a class="toc-backref" href="#id9">Comments</a></h2> +<p>Is considered as comment (and therefore ignored) everything between a number +sign (<tt class="docutils literal">#</tt>) and the following end of line, unless the <tt class="docutils literal">#</tt> occurs as part of +another syntactic element (such as a string literal).</p> +<p>A short example:</p> +<pre class="literal-block"> +# This is a comment +key = value; # This is also a comment +string = "A string. # This isn't a comment but a string"; +</pre> +</div> +<div class="section" id="value-types"> +<h2><a class="toc-backref" href="#id10">Value types</a></h2> +<dl class="docutils"> +<dt>string</dt> +<dd><p class="first">A string literal. String literals are surrounded by either single (<tt class="docutils literal">'</tt>) or +double (<tt class="docutils literal">"</tt>) quotes.</p> +<p>Some special characters can be inserted in a string with an escape sequence:</p> +<dl class="docutils"> +<dt><tt class="docutils literal">\t</tt></dt> +<dd>A tabulation.</dd> +<dt><tt class="docutils literal">\n</tt></dt> +<dd>A new line.</dd> +<dt><tt class="docutils literal">\r</tt></dt> +<dd>A carriage return.</dd> +<dt><tt class="docutils literal">\\</tt></dt> +<dd>A backslash.</dd> +<dt><tt class="docutils literal">\'</tt></dt> +<dd>A single quote (escaping only needed in single-quotes surrounded strings).</dd> +<dt><tt class="docutils literal">\"</tt></dt> +<dd>A double quote (escaping only needed in double-quotes surrounded strings).</dd> +</dl> +<p>Note that backslashes are used as the escaping character, which means that it +must be escaped to be treated as a simple backslash character.</p> +<p>A simple example:</p> +<pre class="last literal-block"> +"This is a string with \"special\" characters.\nThis is another line!" +</pre> +</dd> +<dt>boolean</dt> +<dd>A boolean. It can take one of the two symbolic values <tt class="docutils literal">True</tt> and <tt class="docutils literal">False</tt>.</dd> +<dt>enumeration</dt> +<dd>An enumeration. It consists of a named constant, generally in capital letters. +The possible values depend on the setting that use this type.</dd> +<dt>flags</dt> +<dd><p class="first">A logical OR of named constants. This is like enumerations but can combine +different values.</p> +<p class="last">The syntax is common for such types and uses the pipe (<tt class="docutils literal">|</tt>) as +combination character. Considering the <tt class="docutils literal">A</tt>, <tt class="docutils literal">B</tt> and <tt class="docutils literal">C</tt> constants, a +valid value could be <tt class="docutils literal">A | C</tt>, which represents both <tt class="docutils literal">A</tt> and <tt class="docutils literal">C</tt> but +not <tt class="docutils literal">B</tt>.</p> +</dd> +<dt>list</dt> +<dd>A list of values (often referred as array).</dd> +</dl> +</div> +</div> +<div class="section" id="file-types"> +<h1><a class="toc-backref" href="#id11">File types</a></h1> +<p>The file type determines which configuration applies to which document. +<em>File type identifiers</em> are the lowercased name of the Geany's file type, for +example "c" or "python".</p> +<p>Configuration for a particular file type goes in a file named +<tt class="docutils literal"><span class="pre">file-type-identifier.conf</span></tt> in the <tt class="docutils literal">filetypes</tt> sub-directory of a +<a class="reference internal" href="#configuration-directories">configuration directory</a>.</p> +<p>A file type configuration can contain two type of things: file-type-wide +settings and any number of <a class="reference internal" href="#documentation-types">documentation types</a>.</p> +<div class="section" id="the-settings-group"> +<h2><a class="toc-backref" href="#id12">The <tt class="docutils literal">settings</tt> group</a></h2> +<p>This group contains the file-type-wide settings.</p> +<dl class="docutils"> +<dt><tt class="docutils literal">match_function_arguments</tt> (string)</dt> +<dd>A regular expression used to extract arguments from a function-style argument +list (functions, methods, macros, etc.). This regular expression should match +one argument at a time and capture only the argument's name. +This setting is a little odd but currently needed to extract argument list +from function definitions.</dd> +<dt><tt class="docutils literal">global_environment</tt> (string)</dt> +<dd>A description of a <a class="reference external" href="http://ctpl.tuxfamily.org/">CTPL</a> environment to add when parsing <a class="reference internal" href="#rules-the-cool-thing">rule</a>'s templates.</dd> +</dl> +</div> +<div class="section" id="the-doctypes-group"> +<h2><a class="toc-backref" href="#id13">The <tt class="docutils literal">doctypes</tt> group</a></h2> +<p>This group contains a list of <a class="reference internal" href="#documentation-types">documentation types</a>.</p> +</div> +</div> +<div class="section" id="documentation-types"> +<h1><a class="toc-backref" href="#id14">Documentation types</a></h1> +<p>A documentation type is a named set of <a class="reference internal" href="#rules-the-cool-thing">rules</a> for a <a class="reference internal" href="#file-types">file type</a>, describing how +to generate a particular type of documentation (i.e. <a class="reference external" href="http://www.doxygen.org">Doxygen</a>, <a class="reference external" href="http://www.gtk.org/gtk-doc/">Gtk-Doc</a>, +<a class="reference external" href="http://www.valadoc.org/">Valadoc</a> or whatever).</p> +<p>A documentation type is identified by its name and must therefore be unique +in a file type. But of course, different file types can define the same +documentation type. It is even recommended for a better consistency to use the +same identifier in different file types when they generate the same type of +documentation (even though it is completely up to you).</p> +<div class="section" id="short-example"> +<h2><a class="toc-backref" href="#id15">Short example</a></h2> +<pre class="literal-block"> +doxygen = { + struct.member = { + template = " /**< {cursor} */"; + position = AFTER; + } + struct.template = "/**\n * @brief: {cursor}\n * \n * \n */\n"; +} +</pre> +</div> +</div> +<div class="section" id="rules-the-cool-thing"> +<h1><a class="toc-backref" href="#id16">Rules: the cool thing</a></h1> +<p>Rules are the actual definition of how documentation is generated. A rule +applies to a symbol type and hierarchy, allowing fine control over which and +how symbols are documented.</p> +<p>A rule is represented as a group of <a class="reference internal" href="#rule-settings">settings</a> in a <a class="reference internal" href="#documentation-types">documentation type</a>. +The name of this group is the <a class="reference internal" href="#type-hierarchy">type hierarchy</a> to which the settings applies.</p> +<div class="section" id="type-hierarchy"> +<h2><a class="toc-backref" href="#id17">Type hierarchy</a></h2> +<p>A type hierarchy is a hierarchy of the types that a symbol must have to match +this rule.</p> +<p>In the symbol side, the type hierarchy is the types of the symbol's parents, +terminated by the symbol's own type. For example, a method in a class would +have a hierarchy like <tt class="docutils literal">class <span class="pre">-></span> method</tt>; and if the class is itself in a +namespace, the hierarchy would the look like <tt class="docutils literal">namespace <span class="pre">-></span> class <span class="pre">-></span> method</tt>, +and so on.</p> +<p>For a rule to apply, its type hierarchy must match <em>the end</em> of the symbol +type hierarchy. For example a rule with the type hierarchy <tt class="docutils literal">class</tt> will match +a symbol with the type hierarchy <tt class="docutils literal">namespace <span class="pre">-></span> class</tt> but not one with +<tt class="docutils literal">class <span class="pre">-></span> method</tt>.</p> +<p>A type hierarchy uses dots (<tt class="docutils literal">.</tt>) to separate types and build the hierarchy. +For example, the type hierarchy representing <tt class="docutils literal">namespace <span class="pre">-></span> class</tt> would be +written <tt class="docutils literal">namespace.class</tt>.</p> +<div class="section" id="known-types"> +<h3><a class="toc-backref" href="#id18">Known types</a></h3> +<dl class="docutils"> +<dt><tt class="docutils literal">class</tt></dt> +<dd>A class.</dd> +<dt><tt class="docutils literal">enum</tt></dt> +<dd>An enumeration.</dd> +<dt><tt class="docutils literal">enumval</tt></dt> +<dd>An enumeration value.</dd> +<dt><tt class="docutils literal">field</tt></dt> +<dd>A field (of a class for example).</dd> +<dt><tt class="docutils literal">function</tt></dt> +<dd>A function.</dd> +<dt><tt class="docutils literal">interface</tt></dt> +<dd>An interface.</dd> +<dt><tt class="docutils literal">member</tt></dt> +<dd>A member (of a structure for example).</dd> +<dt><tt class="docutils literal">method</tt></dt> +<dd>A method.</dd> +<dt><tt class="docutils literal">namespace</tt></dt> +<dd>A namespace.</dd> +<dt><tt class="docutils literal">package</tt></dt> +<dd>A package.</dd> +<dt><tt class="docutils literal">prototype</tt></dt> +<dd>A prototype.</dd> +<dt><tt class="docutils literal">struct</tt></dt> +<dd>A structure.</dd> +<dt><tt class="docutils literal">typedef</tt></dt> +<dd>A type alias definition (<em>typedef</em> in C).</dd> +<dt><tt class="docutils literal">union</tt></dt> +<dd>An union.</dd> +<dt><tt class="docutils literal">variable</tt></dt> +<dd>A variable.</dd> +<dt><tt class="docutils literal">extern</tt></dt> +<dd><cite>???</cite></dd> +<dt><tt class="docutils literal">define</tt></dt> +<dd>A definition (like the <em>define</em> C preprocessor macro).</dd> +<dt><tt class="docutils literal">macro</tt></dt> +<dd>A macro.</dd> +<dt><tt class="docutils literal">file</tt></dt> +<dd>A file (will never match).</dd> +</dl> +</div> +</div> +<div class="section" id="rule-settings"> +<h2><a class="toc-backref" href="#id19">Rule settings</a></h2> +<dl class="docutils"> +<dt><tt class="docutils literal">template</tt> (string)</dt> +<dd><p class="first">A <a class="reference external" href="http://ctpl.tuxfamily.org/">CTPL</a> template that can include references to the following predefined +variables in addition to the file-type-wide and the global environment:</p> +<dl class="docutils"> +<dt><tt class="docutils literal">argument_list</tt> (string list)</dt> +<dd>A list of the arguments of the currently documented symbol.</dd> +<dt><tt class="docutils literal">returns</tt> (boolean)</dt> +<dd>Indicates whether the currently documented symbol returns a value +(makes sense only for symbols that may return a value).</dd> +<dt><tt class="docutils literal">children</tt> (string list)</dt> +<dd>A list of the current symbol's first-level children. This is only set if +the rule's setting <tt class="docutils literal">children</tt> is set to <tt class="docutils literal">MERGE</tt>.</dd> +</dl> +<p><strong>[...]</strong></p> +<dl class="last docutils"> +<dt><tt class="docutils literal">cursor</tt> (special, described below)</dt> +<dd>This can be used to mark in the template the position where the editor's +cursor should be moved to after comment insertion. +This mark will be removed from the generated documentation. +Note that even if this mark may occur as many times as you want in a +template, only the first will be actually honored, the latter being +only removed.</dd> +</dl> +</dd> +<dt><tt class="docutils literal">position</tt> (enumeration)</dt> +<dd><p class="first">The position where the documentation should be inserted. Possible values are:</p> +<dl class="last docutils"> +<dt><tt class="docutils literal">BEFORE</tt> <a class="citation-reference" href="#default" id="id1">[default]</a></dt> +<dd>Inserts the documentation just before the symbol.</dd> +<dt><tt class="docutils literal">AFTER</tt></dt> +<dd>Inserts the documentation just after the symbol (currently quite limited, it +inserts the documentation at the end of the symbol's first line).</dd> +<dt><tt class="docutils literal">CURSOR</tt></dt> +<dd>Inserts the documentation at the current cursor position.</dd> +</dl> +</dd> +<dt><tt class="docutils literal">policy</tt> (enumeration)</dt> +<dd><p class="first">How the symbol is documented. Possible values are:</p> +<dl class="last docutils"> +<dt><tt class="docutils literal">KEEP</tt> <a class="citation-reference" href="#default" id="id2">[default]</a></dt> +<dd>The symbol documents itself.</dd> +<dt><tt class="docutils literal">FORWARD</tt></dt> +<dd>Forward the documentation request to the parent. This is useful for symbols +that are documented by their parent, such as <a class="reference external" href="http://www.gtk.org/gtk-doc/">Gtk-Doc</a>'s enumerations.</dd> +</dl> +</dd> +<dt><tt class="docutils literal">children</tt> (enumeration)</dt> +<dd><p class="first">How the symbol's children can be used in the template. Possible values are:</p> +<dl class="last docutils"> +<dt><tt class="docutils literal">SPLIT</tt> <a class="citation-reference" href="#default" id="id3">[default]</a></dt> +<dd>The symbol's children are provided as per-type lists.</dd> +<dt><tt class="docutils literal">MERGE</tt></dt> +<dd>The symbol's children are provided as a single list named <tt class="docutils literal">children</tt>.</dd> +</dl> +</dd> +<dt><tt class="docutils literal">matches</tt> (flags)</dt> +<dd>List of the children types that should be provided. Only useful if the +<tt class="docutils literal">children</tt> setting is set to <tt class="docutils literal">MERGE</tt>. +Defaults to all. +<strong>FIXME: check the exactitude of this description</strong></dd> +<dt><tt class="docutils literal">auto_doc_children</tt> (boolean)</dt> +<dd>Whether to also document symbol's children (according to their own rules).</dd> +</dl> +</div> +</div> +<div class="section" id="user-interface-in-geany"> +<h1><a class="toc-backref" href="#id20">User interface in Geany</a></h1> +<div class="section" id="menus"> +<h2><a class="toc-backref" href="#id21">Menus</a></h2> +<p>GeanyGenDoc adds an item named <cite>Insert Documentation Comment</cite> in the editor's +pop-up under the <cite>Insert Comments</cite> sub-menu; and a menu named +<cite>Documentation Generator</cite> into the <cite>Tools</cite> menu.</p> +<div class="section" id="editor-s-pop-up-menu"> +<h3><a class="toc-backref" href="#id22">Editor's pop-up menu</a></h3> +<p>The item <cite>Editor's pop-up → Insert Comments → Insert Documentation Comment</cite> +generates documentation for the current symbol. It has a keyboard shortcut +that can be configured through Geany's keybinding configuration system, under +<cite>GeanyGenDoc → Insert Documentation Comment</cite>.</p> +</div> +<div class="section" id="tools-menu"> +<h3><a class="toc-backref" href="#id23">Tools menu</a></h3> +<p>The <cite>Documentation Generator</cite> menu under <cite>Tools</cite> contains the following items:</p> +<dl class="docutils"> +<dt><cite>Document Current Symbol</cite></dt> +<dd>This generates documentation for the current symbol. It is equivalent to the +item <cite>Insert Documentation Comment</cite> that can be found in the editor's pop-up +menu.</dd> +<dt><cite>Document All Symbols</cite></dt> +<dd>This generates documentation for all symbols in the document. This is +equivalent to manually requesting documentation generation for each symbol in +the document.</dd> +<dt><cite>Reload Configuration Files</cite></dt> +<dd>This force reloading of all the <a class="reference internal" href="#file-types">file type</a> configuration files. It is +useful when a file type configuration file was modified, in order to the new +configuration to be used without reloading the plugin.</dd> +<dt><cite>Edit Current Language Configuration</cite></dt> +<dd>This opens the configuration file that applies to the current document for +editing. The opened configuration file has write permissions: if it was a +system configuration file it is copied under your personal <a class="reference internal" href="#configuration-directories">configuration +directory</a> transparently.</dd> +<dt><cite>Open Manual</cite></dt> +<dd>Opens this manual in a browser.</dd> +</dl> +</div> +</div> +<div class="section" id="preferences-dialog"> +<h2><a class="toc-backref" href="#id24">Preferences dialog</a></h2> +<p>The preferences dialog, than can either be opened through <cite>Edit → +Plugin Preferences</cite> or with the <cite>Preferences</cite> button in the plugin manager, +allows to modify the following preferences:</p> +<dl class="docutils"> +<dt><cite>General</cite></dt> +<dd><dl class="first last docutils"> +<dt><cite>Save file before generating documentation</cite></dt> +<dd>Choose whether the current document should be saved to disc before +generating the documentation. This is a technical detail, but it is +currently needed to have an up-to-date tag list. If you disable this option +and ask for documentation generation on a modified document, the behavior +may be surprising since the comment will be generated for the last saved +state of the document and not the current one.</dd> +<dt><cite>Indent inserted documentation</cite></dt> +<dd>Chooses whether the inserted documentation should be indented to fit the +indentation at the insertion position.</dd> +</dl> +</dd> +<dt><cite>Documentation type</cite></dt> +<dd>This list allows you to choose the documentation type to use with each file +type. The special language <cite>All</cite> on top of the list is used to choose the +default documentation type, used for all languages that haven't one set.</dd> +<dt><cite>Global environment</cite></dt> +<dd>Global environment overrides and additions. This is an environment that will +be merged with the <a class="reference internal" href="#file-types">file type</a>-specific ones, possibly overriding some parts. +It can be used to define some values for all the file types, such as whether +to write the common <cite>Since</cite> tag, define the <a class="reference external" href="http://www.doxygen.org">Doxygen</a> prefix an so on. +Its most use case is not to need to change a file type's environment to change +the value of one of its elements.</dd> +</dl> +</div> +</div> +<div class="section" id="miscellaneous"> +<h1><a class="toc-backref" href="#id25">Miscellaneous</a></h1> +<div class="section" id="configuration-directories"> +<h2><a class="toc-backref" href="#id26">Configuration directories</a></h2> +<p>Configuration directories hold GeanyGenDoc's configuration. They are the +following:</p> +<ul class="simple"> +<li>The user-specific configuration directory, containing the user-defined +settings is <tt class="docutils literal">$GEANY_USER_CONFIG/plugins/geanygendoc/</tt>. +<tt class="docutils literal">$GEANY_USER_CONFIG</tt> is generally <tt class="docutils literal"><span class="pre">~/.config/geany/</span></tt> on UNIX systems.</li> +<li>The system-wide configuration directory containing the default and +pre-installed configuration is <tt class="docutils literal">$GEANY_SYS_CONFIG/plugins/geanygendoc/</tt>. +<tt class="docutils literal">$GEANY_SYS_CONFIG</tt> is generally <tt class="docutils literal">/usr/share/geany/</tt> or +<tt class="docutils literal">/usr/local/share/geany</tt> on UNIX systems.</li> +</ul> +<p>When searching for configuration, GeanyGenDoc will first look in the +user's configuration directory, and if it wasn't successful, in the system +configuration directory. If both failed, it assumes that there is no +configuration at all.</p> +</div> +</div> +<div class="section" id="appendix"> +<h1><a class="toc-backref" href="#id27">Appendix</a></h1> +<div class="section" id="configuration-syntax-summary"> +<h2><a class="toc-backref" href="#id28">Configuration syntax summary</a></h2> +<pre class="literal-block"> +string ::= ( """ .* """ | "'" .* "'" ) +constant ::= [_A-Z][_A-Z0-9]+ +integer ::= [0-9]+ +boolean ::= ( "True" | "False" ) +setting_value ::= ( string | constant | integer ) +setting ::= "setting-name" "=" setting_value ";" +setting_list ::= ( "{" setting* "}" | setting ) +setting_section ::= "settings" "=" setting_list + +position ::= ( "BEFORE" | "AFTER" | "CURSOR" ) +policy ::= ( "KEEP" | "FORWARD" ) +children ::= ( "SPLIT" | "MERGE" ) +type ::= ( "class" | "enum" | "enumval" | "field" | + "function" | "interface" | "member" | "method" | + "namespace" | "package" | "prototype" | "struct" | + "typedef" | "union" | "variable" | "extern" | + "define" | "macro" | "file" ) +matches ::= type ( "|" type )* +doctype_subsetting ::= ( "template" "=" string | + "position" "=" position | + "policy" "=" policy | + "children" "=" children | + "matches" "=" matches | + "auto_doc_children" "=" boolean ) ";" +match ::= type ( "." type )* +doctype_setting ::= ( match "=" "{" doctype_subsetting* "}" | + match "." doctype_subsetting ) +doctype_setting_list ::= ( "{" doctype_setting* "}" | doctype_setting ) +doctype ::= "doctype-name" "=" doctype_setting_list +doctype_list ::= ( "{" doctype* "}" | doctype ) +doctype_section ::= "doctypes" "=" doctype_list + +document ::= ( setting_section? doctype_section? | + doctype_section? setting_section? ) +</pre> + + + + + +<hr class="docutils" /> +<table class="docutils citation" frame="void" id="default" rules="none"> +<colgroup><col class="label" /><col /></colgroup> +<tbody valign="top"> +<tr><td class="label">[default]</td><td><em>(<a class="fn-backref" href="#id1">1</a>, <a class="fn-backref" href="#id2">2</a>, <a class="fn-backref" href="#id3">3</a>)</em> This is the default value of the setting</td></tr> +</tbody> +</table> +</div> +</div> +</div> +<div class="footer"> +<hr class="footer" /> +Generated on: 2010-05-22. + +</div> +</body> +</html> This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

1 0

SF.net SVN: geany-plugins:[1383] trunk/geany-plugins/geanygendoc
by colombanw＠users.sourceforge.net 23 May '10

23 May '10

Revision: 1383 http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1383&view=rev Author: colombanw Date: 2010-05-22 23:19:51 +0000 (Sat, 22 May 2010) Log Message: ----------- GeanyGenDoc: Remove some obsolete files Drop some leftover files that was obsoleted by the import in geany-plugins. Removed Paths: ------------- trunk/geany-plugins/geanygendoc/autogen.sh trunk/geany-plugins/geanygendoc/configure.ac Deleted: trunk/geany-plugins/geanygendoc/autogen.sh =================================================================== --- trunk/geany-plugins/geanygendoc/autogen.sh 2010-05-22 22:34:05 UTC (rev 1382) +++ trunk/geany-plugins/geanygendoc/autogen.sh 2010-05-22 23:19:51 UTC (rev 1383) @@ -1,8 +0,0 @@ -#!/bin/sh - - -mkdir -p build/aux || exit 1 -mkdir -p build/m4 || exit 1 -#~ gtkdocize --flavour no-tmpl || exit 1 -glib-gettextize -c -f || exit 1 -autoreconf -vfi || exit 1 Deleted: trunk/geany-plugins/geanygendoc/configure.ac =================================================================== --- trunk/geany-plugins/geanygendoc/configure.ac 2010-05-22 22:34:05 UTC (rev 1382) +++ trunk/geany-plugins/geanygendoc/configure.ac 2010-05-22 23:19:51 UTC (rev 1383) @@ -1,90 +0,0 @@ -# Process this file with autoconf to produce a configure script. - -AC_PREREQ([2.64]) -AC_INIT([geanygendoc], - [0.1], - [ban(a)herbesfolles.org], - [geanygendoc]) -AC_CONFIG_SRCDIR([src/ggd.c]) -AC_CONFIG_AUX_DIR([build/aux]) -AC_CONFIG_MACRO_DIR([build/m4]) -AM_INIT_AUTOMAKE([1.11.1 -Wall -Werror foreign]) -AC_CONFIG_HEADERS([config.h]) - -m4_ifdef([AM_SILENT_RULES], [AM_SILENT_RULES([yes])]) - -AC_PROG_CC -LT_PREREQ([2.2.0]) -LT_INIT([disable-static]) -AC_PROG_INSTALL - -AC_PATH_PROG([RST2HTML], [rst2html], [no]) -AC_SUBST([RST2HTML]) -BUILD_RST=`test "x$RST2HTML" != "xno" && echo Yes || echo No` -AM_CONDITIONAL([BUILD_RST], [test "x$BUILD_RST" == "xYes"]) - -# checking for Geany -PKG_CHECK_MODULES(GEANY, [geany >= 0.18.1]) -PKG_CHECK_MODULES(GTK, [gtk+-2.0 >= 2.12]) -PKG_CHECK_MODULES(GLIB, [glib-2.0 >= 2.14]) -# need GIO >= 2.18 for g_memory_output_stream_get_data_size() -PKG_CHECK_MODULES(GIO, [gio-2.0 >= 2.18]) -PKG_CHECK_MODULES(CTPL, [ctpl >= 0.2]) - -GEANY_VERSION=`$PKG_CONFIG --modversion geany` -GTK_VERSION=`$PKG_CONFIG --modversion gtk+-2.0` -GLIB_VERSION=`$PKG_CONFIG --modversion glib-2.0` -GIO_VERSION=`$PKG_CONFIG --modversion gio-2.0` -CTPL_VERSION=`$PKG_CONFIG --modversion ctpl` - -# i18n -GETTEXT_PACKAGE=geanygendoc -AC_SUBST(GETTEXT_PACKAGE) -AC_DEFINE_UNQUOTED(GETTEXT_PACKAGE, "$GETTEXT_PACKAGE", [Gettext package.]) - -ALL_LINGUAS="`sed -e '/^#/d' $srcdir/po/LINGUAS`" # take all languages found in file po/LINGUAS - -AM_GLIB_GNU_GETTEXT -# workaround for intltool bug (http://bugzilla.gnome.org/show_bug.cgi?id=490845) -if test "x$MSGFMT" = "xno"; then - AC_MSG_ERROR([msgfmt not found. Please install the gettext package.]) -fi - -# intltool hack to define install_sh on Debian/Ubuntu systems -if test "x$install_sh" = "x"; then - install_sh="`pwd`/install-sh" - AC_SUBST(install_sh) -fi - -# get the plugin installed at the correct location for Geany -# TODO find a way to NOT override --libdir command line option if given -libdir="`$PKG_CONFIG --variable=libdir geany`/geany" -# same for the data, since we use geany->app->datadir -plugindatadir="`$PKG_CONFIG --variable=datadir geany`/geany/plugins/${PACKAGE_TARNAME}" -AC_SUBST([plugindatadir]) -# docdir -docdir="`$PKG_CONFIG --variable=prefix geany`/share/doc/geany-plugins/${PACKAGE_TARNAME}/" - - -AC_CONFIG_FILES([ - README - Makefile - src/Makefile - data/Makefile - data/filetypes/Makefile - po/Makefile.in - docs/Makefile - docs/help/Makefile -]) -AC_OUTPUT - -echo "----------------------------------------" -echo "Using Geany version : ${GEANY_VERSION}" -echo "Using GLib version : ${GLIB_VERSION}" -echo "Using GIO version : ${GIO_VERSION}" -echo "Using GTK version : ${GTK_VERSION}" -echo "Using CTPL version : ${CTPL_VERSION}" -echo "Build documentation : $BUILD_RST" -echo "" -echo "Configuration is done OK." -echo "" This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

1 0

SF.net SVN: geany-plugins:[1382] trunk/geany-plugins/geanygendoc
by colombanw＠users.sourceforge.net 23 May '10

23 May '10

Revision: 1382 http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1382&view=rev Author: colombanw Date: 2010-05-22 22:34:05 +0000 (Sat, 22 May 2010) Log Message: ----------- GeanyGenDoc: Temporary hackish fix for data installation Manually work around the approximation of $(datadir). Should probably still be fixed. Modified Paths: -------------- trunk/geany-plugins/geanygendoc/ChangeLog trunk/geany-plugins/geanygendoc/Makefile.am trunk/geany-plugins/geanygendoc/data/filetypes/Makefile.am trunk/geany-plugins/geanygendoc/src/ggd-utils.c Modified: trunk/geany-plugins/geanygendoc/ChangeLog =================================================================== --- trunk/geany-plugins/geanygendoc/ChangeLog 2010-05-22 21:43:18 UTC (rev 1381) +++ trunk/geany-plugins/geanygendoc/ChangeLog 2010-05-22 22:34:05 UTC (rev 1382) @@ -7,6 +7,8 @@ Add an entry in the TODO-list * [All] Import into Geany-Plugins. + * ChangeLog, Makefile.am, data/filetypes/Makefile.am, src/ggd-utils.c: + Temporary hackish fix for data installation. 2010-05-21 Colomban Wendling <ban(at)herbesfolles(dot)org> Modified: trunk/geany-plugins/geanygendoc/Makefile.am =================================================================== --- trunk/geany-plugins/geanygendoc/Makefile.am 2010-05-22 21:43:18 UTC (rev 1381) +++ trunk/geany-plugins/geanygendoc/Makefile.am 2010-05-22 22:34:05 UTC (rev 1382) @@ -5,7 +5,5 @@ EXTRA_DIST = $(AUXFILES) endif -SUBDIRS = src docs -# don't install data because it doesn't work for now -#SUBDIRS += data +SUBDIRS = src docs data plugin = geanygendoc Modified: trunk/geany-plugins/geanygendoc/data/filetypes/Makefile.am =================================================================== --- trunk/geany-plugins/geanygendoc/data/filetypes/Makefile.am 2010-05-22 21:43:18 UTC (rev 1381) +++ trunk/geany-plugins/geanygendoc/data/filetypes/Makefile.am 2010-05-22 22:34:05 UTC (rev 1382) @@ -1,5 +1,7 @@ if ENABLE_GEANYGENDOC plugin = geanygendoc +# FIXME: should probably done by an included .mk such as vars.data.mk +plugindatadir = $(datadir)/geany-plugins/$(plugin) endif FILETYPES = c.conf \ Modified: trunk/geany-plugins/geanygendoc/src/ggd-utils.c =================================================================== --- trunk/geany-plugins/geanygendoc/src/ggd-utils.c 2010-05-22 21:43:18 UTC (rev 1381) +++ trunk/geany-plugins/geanygendoc/src/ggd-utils.c 2010-05-22 22:34:05 UTC (rev 1382) @@ -153,8 +153,10 @@ user_dir = g_build_filename (G_DIR_SEPARATOR_S, geany->app->configdir, "plugins", GGD_PLUGIN_CNAME, section, NULL); - system_dir = g_build_filename (G_DIR_SEPARATOR_S, geany->app->datadir, - "plugins", GGD_PLUGIN_CNAME, section, NULL); + /* FIXME: this should probably be fixed together with the build system not + * to need to explicitly add the "geany-plugins" part */ + system_dir = g_build_filename (DATADIR, "geany-plugins", GGD_PLUGIN_CNAME, + section, NULL); user_path = g_build_filename (user_dir, name, NULL); system_path = g_build_filename (system_dir, name, NULL); if (perms_req & GGD_PERM_R) { This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

1 0

SF.net SVN: geany-plugins:[1381] trunk/geany-plugins/geanygendoc/ChangeLog
by colombanw＠users.sourceforge.net 22 May '10

22 May '10

Revision: 1381 http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1381&view=rev Author: colombanw Date: 2010-05-22 21:43:18 +0000 (Sat, 22 May 2010) Log Message: ----------- GeanyGenDoc: Naive anti-bot email address escaping Modified Paths: -------------- trunk/geany-plugins/geanygendoc/ChangeLog Modified: trunk/geany-plugins/geanygendoc/ChangeLog =================================================================== --- trunk/geany-plugins/geanygendoc/ChangeLog 2010-05-22 21:37:13 UTC (rev 1380) +++ trunk/geany-plugins/geanygendoc/ChangeLog 2010-05-22 21:43:18 UTC (rev 1381) @@ -1,4 +1,4 @@ -2010-05-22 Colomban Wendling <ban(a)herbesfolles.org> +2010-05-22 Colomban Wendling <ban(at)herbesfolles(dot)org> * src/ggd-plugin.c: Fix packing of the General frame not to expand unnecessarily, which @@ -9,7 +9,7 @@ Import into Geany-Plugins. -2010-05-21 Colomban Wendling <ban(a)herbesfolles.org> +2010-05-21 Colomban Wendling <ban(at)herbesfolles(dot)org> * docs/help/manual.rst: Add a new section in the manual that presents and describes the UI @@ -27,13 +27,13 @@ likely to use Javadoc, Vala to use Valadoc, etc.). -2010-05-20 Colomban Wendling <ban(a)herbesfolles.org> +2010-05-20 Colomban Wendling <ban(at)herbesfolles(dot)org> * TODO, src/ggd-plugin.c: Use an helper function to add menu items -2010-05-11 Colomban Wendling <ban(a)herbesfolles.org> +2010-05-11 Colomban Wendling <ban(at)herbesfolles(dot)org> * src/ggd-options.c: Make option saving more robust against corrupted conffile. @@ -42,7 +42,7 @@ the configuration file does not exist or exists but is corrupted. -2010-05-09 Colomban Wendling <ban(a)herbesfolles.org> +2010-05-09 Colomban Wendling <ban(at)herbesfolles(dot)org> * configure.ac: Show whether to build documentation on configure summary @@ -50,7 +50,7 @@ Clarify the manual by saying for what the syntax is used -2010-05-04 Colomban Wendling <ban(a)herbesfolles.org> +2010-05-04 Colomban Wendling <ban(at)herbesfolles(dot)org> * src/Makefile.am, src/ggd-plugin.c: Add a menu item to open the manual @@ -60,7 +60,7 @@ Add a manual and install it (and other missing documentation files). -2010-05-01 Colomban Wendling <ban(a)herbesfolles.org> +2010-05-01 Colomban Wendling <ban(at)herbesfolles(dot)org> * src/ggd.c: Don't use a hard-coded list of what can have arguments. @@ -107,7 +107,7 @@ arguments and return type (oops). -2010-04-29 Colomban Wendling <ban(a)herbesfolles.org> +2010-04-29 Colomban Wendling <ban(at)herbesfolles(dot)org> * src/ggd-doc-setting.c, src/ggd-doc-setting.h, src/ggd-doc-type.c, src/ggd-doc-type.h, src/ggd-file-type-loader.c, src/ggd-file-type-loader.h, @@ -134,7 +134,7 @@ visibility. -2010-04-28 Colomban Wendling <ban(a)herbesfolles.org> +2010-04-28 Colomban Wendling <ban(at)herbesfolles(dot)org> * src/ggd-plugin.c: Show the "indent" preference in the plugin's preference dialog. @@ -149,7 +149,7 @@ Prefix the options with GGD_ since they are now exported. -2010-04-26 Colomban Wendling <ban(a)herbesfolles.org> +2010-04-26 Colomban Wendling <ban(at)herbesfolles(dot)org> * po/fr.po: Update French translation @@ -170,7 +170,7 @@ each children of i.e. a structure. -2010-04-24 Colomban Wendling <ban(a)herbesfolles.org> +2010-04-24 Colomban Wendling <ban(at)herbesfolles(dot)org> * data/filetypes/c.conf: Use new cursor positioning in C filetype configuration @@ -194,7 +194,7 @@ without rules. -2010-04-22 Colomban Wendling <ban(a)herbesfolles.org> +2010-04-22 Colomban Wendling <ban(at)herbesfolles(dot)org> * TODO, src/ggd-tag-utils.c: Fix ordering of tag children @@ -226,7 +226,7 @@ directory. Sorry for this. -2010-04-21 Colomban Wendling <ban(a)herbesfolles.org> +2010-04-21 Colomban Wendling <ban(at)herbesfolles(dot)org> * src/ggd-plugin.c: Make editor's menu action work at the popup position @@ -250,7 +250,7 @@ Move GGD_PTR_ARRAY_FOR() to ggd-utils -2010-04-20 Colomban Wendling <ban(a)herbesfolles.org> +2010-04-20 Colomban Wendling <ban(at)herbesfolles(dot)org> * src/ggd-tag-utils.c, src/ggd-tag-utils.h: Make tag find functions take a const array @@ -267,7 +267,7 @@ operation) and no more modification of the given tag array. -2010-04-18 Colomban Wendling <ban(a)herbesfolles.org> +2010-04-18 Colomban Wendling <ban(at)herbesfolles(dot)org> * AUTHORS, COPYING, INSTALL, Makefile.am, README.in, TODO, autogen.sh, configure.ac, data/Makefile.am, data/filetypes/Makefile.am, This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

1 0

SF.net SVN: geany-plugins:[1380] trunk/geany-plugins
by colombanw＠users.sourceforge.net 22 May '10

22 May '10

Revision: 1380 http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1380&view=rev Author: colombanw Date: 2010-05-22 21:37:13 +0000 (Sat, 22 May 2010) Log Message: ----------- Import GeanyGenDoc into geany-plugins Things left to do: * Install the data files; * Waf build. Modified Paths: -------------- trunk/geany-plugins/Makefile.am trunk/geany-plugins/configure.ac trunk/geany-plugins/geanygendoc/Makefile.am trunk/geany-plugins/geanygendoc/data/filetypes/Makefile.am trunk/geany-plugins/geanygendoc/docs/help/Makefile.am trunk/geany-plugins/geanygendoc/src/Makefile.am trunk/geany-plugins/geanygendoc/src/ggd-plugin.c trunk/geany-plugins/geanygendoc/src/ggd-plugin.h trunk/geany-plugins/po/POTFILES.in Added Paths: ----------- trunk/geany-plugins/build/geanygendoc.m4 trunk/geany-plugins/geanygendoc/ trunk/geany-plugins/geanygendoc/ChangeLog trunk/geany-plugins/geanygendoc/NEWS Removed Paths: ------------- trunk/geany-plugins/geanygendoc/po/ Modified: trunk/geany-plugins/Makefile.am =================================================================== --- trunk/geany-plugins/Makefile.am 2010-05-22 12:48:44 UTC (rev 1379) +++ trunk/geany-plugins/Makefile.am 2010-05-22 21:37:13 UTC (rev 1380) @@ -4,6 +4,7 @@ geanydoc \ geanyextrasel \ geanygdb \ + geanygendoc \ geanyinsertnum \ geanylatex \ geanylipsum \ Added: trunk/geany-plugins/build/geanygendoc.m4 =================================================================== --- trunk/geany-plugins/build/geanygendoc.m4 (rev 0) +++ trunk/geany-plugins/build/geanygendoc.m4 2010-05-22 21:37:13 UTC (rev 1380) @@ -0,0 +1,61 @@ +AC_DEFUN([GP_CHECK_GEANYGENDOC], +[ + AC_ARG_ENABLE(geanygendoc, + AC_HELP_STRING([--enable-geanygendoc=ARG], + [Enable GeanyGenDoc plugin [[default=auto]]]),, + [enable_geanygendoc=auto]) + + GTK_VERSION=2.12 + GLIB_VERSION=2.14 + GIO_VERSION=2.18 + CTPL_VERSION=0.2 + + geanygendoc_have_gtk=no + geanygendoc_have_glib=no + geanygendoc_have_gio=no + geanygendoc_have_ctpl=no + if [[ x"$enable_geanygendoc" = "xauto" ]]; then + PKG_CHECK_MODULES(GTK, [gtk+-2.0 >= ${GTK_VERSION}], + [geanygendoc_have_gtk=yes], + [geanygendoc_have_gtk=no]) + PKG_CHECK_MODULES(GLIB, [glib-2.0 >= ${GLIB_VERSION}], + [geanygendoc_have_glib=yes], + [geanygendoc_have_glib=no]) + PKG_CHECK_MODULES(GIO, [gio-2.0 >= ${GIO_VERSION}], + [geanygendoc_have_gio=yes], + [geanygendoc_have_gio=no]) + PKG_CHECK_MODULES(CTPL, [ctpl >= ${CTPL_VERSION}], + [geanygendoc_have_ctpl=yes], + [geanygendoc_have_ctpl=no]) + if [[ $geanygendoc_have_gtk = yes ]] && + [[ $geanygendoc_have_glib = yes ]] && + [[ $geanygendoc_have_gio = yes ]] && + [[ $geanygendoc_have_ctpl = yes ]]; then + enable_geanygendoc=yes + else + enable_geanygendoc=no + fi + elif [[ x"$enable_geanygendoc" = "xyes" ]]; then + PKG_CHECK_MODULES(GTK, [gtk+-2.0 >= ${GTK_VERSION}]) + PKG_CHECK_MODULES(GLIB, [glib-2.0 >= ${GLIB_VERSION}]) + PKG_CHECK_MODULES(GIO, [gio-2.0 >= ${GIO_VERSION}]) + PKG_CHECK_MODULES(CTPL, [ctpl >= ${CTPL_VERSION}]) + fi + + AC_PATH_PROG([RST2HTML], [rst2html], [no]) + AC_SUBST([RST2HTML]) + AM_CONDITIONAL([BUILD_RST], [test "x$RST2HTML" != "xno"]) + + AM_CONDITIONAL(ENABLE_GEANYGENDOC, test $enable_geanygendoc = yes) + GP_STATUS_PLUGIN_ADD([GeanyGenDoc], [$enable_geanygendoc]) + + AC_CONFIG_FILES([ + geanygendoc/README + geanygendoc/Makefile + geanygendoc/src/Makefile + geanygendoc/data/Makefile + geanygendoc/data/filetypes/Makefile + geanygendoc/docs/Makefile + geanygendoc/docs/help/Makefile + ]) +]) Modified: trunk/geany-plugins/configure.ac =================================================================== --- trunk/geany-plugins/configure.ac 2010-05-22 12:48:44 UTC (rev 1379) +++ trunk/geany-plugins/configure.ac 2010-05-22 21:37:13 UTC (rev 1380) @@ -26,6 +26,7 @@ GP_CHECK_GEANYDOC GP_CHECK_GEANYEXTRASEL GP_CHECK_GEANYGDB +GP_CHECK_GEANYGENDOC GP_CHECK_GEANYINSERTNUM GP_CHECK_GEANYLATEX GP_CHECK_GEANYLIPSUM Added: trunk/geany-plugins/geanygendoc/ChangeLog =================================================================== --- trunk/geany-plugins/geanygendoc/ChangeLog (rev 0) +++ trunk/geany-plugins/geanygendoc/ChangeLog 2010-05-22 21:37:13 UTC (rev 1380) @@ -0,0 +1,282 @@ +2010-05-22 Colomban Wendling <ban(a)herbesfolles.org> + + * src/ggd-plugin.c: + Fix packing of the General frame not to expand unnecessarily, which + would break other expansions. + * TODO: + Add an entry in the TODO-list + * [All] + Import into Geany-Plugins. + + +2010-05-21 Colomban Wendling <ban(a)herbesfolles.org> + + * docs/help/manual.rst: + Add a new section in the manual that presents and describes the UI + that the plugin adds to Geany. + * src/ggd-file-type-loader.c, src/ggd-file-type-manager.c, src/ggd-options.c, + src/ggd-plugin.c, src/ggd-utils.c, src/ggd-widget-doctype-selector.c, + src/ggd.c: + Strings review + * src/ggd-plugin.c: + Open the manual on plugin_help() + * TODO, src/Makefile.am, src/ggd-plugin.c, src/ggd-plugin.h, + src/ggd-widget-doctype-selector.c, src/ggd-widget-doctype-selector.h: + Support per-filetype documentation type setting. This is useful since + different languages may not share the same doctype (e.g. Java is + likely to use Javadoc, Vala to use Valadoc, etc.). + + +2010-05-20 Colomban Wendling <ban(a)herbesfolles.org> + + * TODO, src/ggd-plugin.c: + Use an helper function to add menu items + + +2010-05-11 Colomban Wendling <ban(a)herbesfolles.org> + + * src/ggd-options.c: + Make option saving more robust against corrupted conffile. + Do not fail saving if the original file cannot be loaded, simply + overwrite with the new settings. This fixes configuration saving when + the configuration file does not exist or exists but is corrupted. + + +2010-05-09 Colomban Wendling <ban(a)herbesfolles.org> + + * configure.ac: + Show whether to build documentation on configure summary + * docs/help/manual.rst: + Clarify the manual by saying for what the syntax is used + + +2010-05-04 Colomban Wendling <ban(a)herbesfolles.org> + + * src/Makefile.am, src/ggd-plugin.c: + Add a menu item to open the manual + * Makefile.am, README.in, configure.ac, docs/Makefile.am, + docs/help/Makefile.am, docs/help/html4css1.css, docs/help/manual.css, + docs/help/manual.rst: + Add a manual and install it (and other missing documentation files). + + +2010-05-01 Colomban Wendling <ban(a)herbesfolles.org> + + * src/ggd.c: + Don't use a hard-coded list of what can have arguments. + Always generate arguments list if the tag have one. + In the same spirit, always generate the "returns" symbol too even + when it doesn't make sense; simply let the template use it or not. + * src/Makefile.am, src/ggd-plugin.c, src/ggd-widget-frame.c, + src/ggd-widget-frame.h: + Implement and use Glade-style frames. + This makes the UI quite nicer and more consistent with both Geany + and GNOME. + * TODO: + Update TODO list + * data/filetypes/Makefile.am, + data/filetypes/vala.conf: + Add basic rules for Vala + * src/ggd-tag-utils.c, src/ggd-tag-utils.h, + src/ggd.c: + Fix tag scope detection for non-c-style languages. + Don't use hard-coded "::" separator but try to find the right + separator for the file type. + * src/ggd.c: + Display a message when no setting applies to a tag. + This eases writing/debugging of rules, and is not that intrusive for + production use. + * configure.ac, src/ggd-plugin.c: + Decrease plugin API dependency to 171, which should be the actual + version we need and should make the plugin work with Geany 0.18.1. + * src/ggd-plugin.c, src/ggd-plugin.h, src/ggd.c: + Support for global environment overrides. + Add a global environment to allow overrides and additions to the + filetype-specific environments. This is useful e.g. to set a "insert + since" property that will apply to all filetypes, an this without + modifying filetypes themselves. + * src/Makefile.am: + Fix distribution of ggd-macros.h + * src/ggd.c: + Fix crash when documenting symbol with no rules set. + Don't try to access the GgdDocSetting.autodoc_children field if the + setting is NULL (oops). + * src/ggd.c: + Fix support of argument list and return type for methods. + Methods was just forgotten in the list of things that can have + arguments and return type (oops). + + +2010-04-29 Colomban Wendling <ban(a)herbesfolles.org> + + * src/ggd-doc-setting.c, src/ggd-doc-setting.h, src/ggd-doc-type.c, + src/ggd-doc-type.h, src/ggd-file-type-loader.c, src/ggd-file-type-loader.h, + src/ggd-file-type-manager.c, src/ggd-file-type-manager.h, + src/ggd-file-type.c, src/ggd-file-type.h, src/ggd-macros.h, + src/ggd-options.c, src/ggd-options.h, src/ggd-plugin.c, src/ggd-plugin.h, + src/ggd-tag-utils.c, src/ggd-tag-utils.h, src/ggd-utils.c, src/ggd-utils.h, + src/ggd.c, src/ggd.h: + Cleanup and fix copyright information: + * Don't use non-ASCII character; + * Don't include nickname in author's name; + * Update some outdated dates; + * Add a short description of the package. + * src/ggd-doc-setting.h, src/ggd-doc-type.h, src/ggd-file-type-loader.h, + src/ggd-file-type-manager.h, src/ggd-file-type.h, src/ggd-macros.h, + src/ggd-options.h, src/ggd-plugin.h, src/ggd-tag-utils.h, src/ggd-utils.h, + src/ggd.h: + Set the "internal" visibility for plugin's symbols. This cleans the + symbol table of the plugin, as well as it might allow the compiler + to do some optimizations. + + This is currently only supported when building with GCC >= 4.2. Builds + with other/older compilers will simply keep their default symbol + visibility. + + +2010-04-28 Colomban Wendling <ban(a)herbesfolles.org> + + * src/ggd-plugin.c: + Show the "indent" preference in the plugin's preference dialog. + * src/ggd-plugin.c, src/ggd-plugin.h, src/ggd.c, src/ggd.h: + Indent the inserted comment according to the insertion position + indentation. This can be disabled by a (currently) hidden "indent" + preference. + Also use editor_insert_text_block() in place of sci_insert_text(), + which fixes line endings to be the right ones for the working file. + * src/ggd-plugin.c, src/ggd-plugin.h: + Plugin options are now available everywhere by including ggd-plugin.h. + Prefix the options with GGD_ since they are now exported. + + +2010-04-26 Colomban Wendling <ban(a)herbesfolles.org> + + * po/fr.po: + Update French translation + * src/ggd-plugin.c: + Add & cleanup some tooltips. + Add tooltips for the tool's menu items; + Cleanup the big tooltip of the save-to-refresh option. + * data/filetypes/c.conf: + Use new auto-generation of children documentation + Use auto-generation of children's documentation for structures, unions + and enumerations in Doxygen format. + * src/ggd-doc-setting.c, src/ggd-doc-setting.h, src/ggd-file-type-loader.c, + src/ggd-tag-utils.c, src/ggd-tag-utils.h, src/ggd.c: + Support automatic documentation of children + Allow a rule to request for automatic generation of its children + documentation. This is useful for fragmented documentation styles + such as Doxygen not to need to manually generate documentation for + each children of i.e. a structure. + + +2010-04-24 Colomban Wendling <ban(a)herbesfolles.org> + + * data/filetypes/c.conf: + Use new cursor positioning in C filetype configuration + * src/ggd.c: + Add support for the special "cursor" variable in templates, allowing + to explicitly place the cursor in the generated comment. + This variable may appear more than once but currently only the first + occurrence that appears in the output comment is honored. + * data/filetypes/c.conf: + Update C filetype configuration + gtkdoc: + * Don't document prototypes; + * Fill-in union rule. + doxygen: + * Add support for more types. + * src/ggd.c: + Fix "document all" when there are symbols not to document + The "document all" action was aborting if the setting for any tag + wasn't found rather than when something went actually wrong. + This fixes the action when called on a file that contains symbols + without rules. + + +2010-04-22 Colomban Wendling <ban(a)herbesfolles.org> + + * TODO, src/ggd-tag-utils.c: + Fix ordering of tag children + Make ggd_tag_find_children() return a sorted list of the tags, in the + order they appears in the source. + This fixes wrong order of some children such as structure members or + enumeration values that were sorted alphabetically. + * src/ggd-doc-setting.c, src/ggd-doc-setting.h, src/ggd-file-type-loader.c, + src/ggd-file-type-loader.h, src/ggd-file-type-manager.c, + src/ggd-file-type.c, src/ggd-options.c, src/ggd-options.h, + src/ggd-tag-utils.c, src/ggd-tag-utils.h, src/ggd-utils.c, src/ggd-utils.h, + src/ggd.c: + Add some code documentation + * TODO: + Update TODO list + * data/filetypes/c.conf: + C configuration: fix match of empty argument list + Cleanly support completely empty argument lists (foo()) used e.g. in + macros with no arguments. + * data/filetypes/c.conf: + Updated default C filetype configuration + * Added template for defines; + * Don't include since tag by default. + * configure.ac: + Fix installation directory of plugin's data (oops) + Install plugin's data in ${prefix}/geany/plugin/${plugin_name} rather + than ${prefix}/geany/{plugin_name}. + If you already have installed the plugin, simply delete the old + directory. Sorry for this. + + +2010-04-21 Colomban Wendling <ban(a)herbesfolles.org> + + * src/ggd-plugin.c: + Make editor's menu action work at the popup position + When inserting documentation by activating the editor's popup menu + item, insert documentation for the popup position rather than for + the cursor's position. + This fixes strange behavior when using editor's popup menu item. + * src/ggd-plugin.c: + Make menu items document-sensitive when it makes sense + * po/fr.po: + Update French translation + * src/ggd-plugin.c: + Add the "Document current symbol" item to the plugin's menu too + * src/ggd-plugin.c, src/ggd.c, src/ggd.h: + Add ability to document a whole file at once + * src/ggd-tag-utils.c, src/ggd-tag-utils.h: + Add sort direction argument to ggd_tag_sort_by_line() + Provide a way to chose sort direction (ascending or descending) with + ggd_tag_sort_by_line(). + * src/ggd-tag-utils.c, src/ggd-utils.h: + Move GGD_PTR_ARRAY_FOR() to ggd-utils + + +2010-04-20 Colomban Wendling <ban(a)herbesfolles.org> + + * src/ggd-tag-utils.c, src/ggd-tag-utils.h: + Make tag find functions take a const array + Tag find functions actually doesn't and shouldn't have to modify the + the given tag list they work on. + * src/ggd-tag-utils.c, src/ggd-tag-utils.h: + Add ggd_tag_sort_by_line() function that sorts a tag array by tag's + line. + * src/ggd-tag-utils.c: + Improve tag search for a given line + Make ggd_tag_find_from_line() use only a linear search rather than + sorting the tag array and then doing an almost linear search. + Benefits are probable speed improvement (array sorting isn't a cheap + operation) and no more modification of the given tag array. + + +2010-04-18 Colomban Wendling <ban(a)herbesfolles.org> + + * AUTHORS, COPYING, INSTALL, Makefile.am, README.in, TODO, autogen.sh, + configure.ac, data/Makefile.am, data/filetypes/Makefile.am, + data/filetypes/c.conf, po/LINGUAS, po/POTFILES.in, po/fr.po, + src/Makefile.am, src/ggd-doc-setting.c, src/ggd-doc-setting.h, + src/ggd-doc-type.c, src/ggd-doc-type.h, src/ggd-file-type-loader.c, + src/ggd-file-type-loader.h, src/ggd-file-type-manager.c, + src/ggd-file-type-manager.h, src/ggd-file-type.c, src/ggd-file-type.h, + src/ggd-options.c, src/ggd-options.h, src/ggd-plugin.c, src/ggd-plugin.h, + src/ggd-tag-utils.c, src/ggd-tag-utils.h, src/ggd-utils.c, src/ggd-utils.h, + src/ggd.c, src/ggd.h: + Initial commit of the plugin Modified: trunk/geany-plugins/geanygendoc/Makefile.am =================================================================== --- trunk/geanygendoc/Makefile.am 2010-05-22 12:48:44 UTC (rev 1379) +++ trunk/geany-plugins/geanygendoc/Makefile.am 2010-05-22 21:37:13 UTC (rev 1380) @@ -1,18 +1,11 @@ +if ENABLE_GEANYGENDOC +include $(top_srcdir)/build/vars.auxfiles.mk +else +include $(top_srcdir)/build/vars.docs.mk +EXTRA_DIST = $(AUXFILES) +endif -SUBDIRS = src data po docs - -ACLOCAL_AMFLAGS = -I build/m4 - -EXTRA_DIST = autogen.sh \ - README \ - po/LINGUAS - -doc_DATA = AUTHORS \ - COPYING \ - README - -sign: - if test -f $(PACKAGE)-$(VERSION).tar.gz; then \ - gpg --detach-sign --digest-algo SHA512 $(PACKAGE)-$(VERSION).tar.gz; fi - if test -f $(PACKAGE)-$(VERSION).tar.bz2; then \ - gpg --detach-sign --digest-algo SHA512 $(PACKAGE)-$(VERSION).tar.bz2; fi +SUBDIRS = src docs +# don't install data because it doesn't work for now +#SUBDIRS += data +plugin = geanygendoc Added: trunk/geany-plugins/geanygendoc/NEWS =================================================================== Modified: trunk/geany-plugins/geanygendoc/data/filetypes/Makefile.am =================================================================== --- trunk/geanygendoc/data/filetypes/Makefile.am 2010-05-22 12:48:44 UTC (rev 1379) +++ trunk/geany-plugins/geanygendoc/data/filetypes/Makefile.am 2010-05-22 21:37:13 UTC (rev 1380) @@ -1,5 +1,13 @@ +if ENABLE_GEANYGENDOC +plugin = geanygendoc +endif + +FILETYPES = c.conf \ + vala.conf + +if ENABLE_GEANYGENDOC filetypesdir = $(plugindatadir)/filetypes -filetypes_DATA = c.conf \ - vala.conf +filetypes_DATA = $(FILETYPES) +endif -EXTRA_DIST = $(filetypes_DATA) +EXTRA_DIST = $(FILETYPES) Modified: trunk/geany-plugins/geanygendoc/docs/help/Makefile.am =================================================================== --- trunk/geanygendoc/docs/help/Makefile.am 2010-05-22 12:48:44 UTC (rev 1379) +++ trunk/geany-plugins/geanygendoc/docs/help/Makefile.am 2010-05-22 21:37:13 UTC (rev 1380) @@ -1,3 +1,9 @@ +if ENABLE_GEANYGENDOC +include $(top_srcdir)/build/vars.docs.mk +plugin = geanygendoc +AIXFILES= +endif ENABLE_GEANYGENDOC + EXTRA_DIST = manual.rst \ manual.css \ html4css1.css @@ -2,6 +8,5 @@ -doc_DATA = - +if ENABLE_GEANYGENDOC if BUILD_RST -doc_DATA += manual.html +plugindoc_DATA = manual.html @@ -12,3 +17,4 @@ manual.html: manual.rst manual.css $(AM_V_GEN) $(RST2HTML) -d --strict --stylesheet-path manual.css $< $@ endif BUILD_RST +endif ENABLE_GEANYGENDOC Modified: trunk/geany-plugins/geanygendoc/src/Makefile.am =================================================================== --- trunk/geanygendoc/src/Makefile.am 2010-05-22 12:48:44 UTC (rev 1379) +++ trunk/geany-plugins/geanygendoc/src/Makefile.am 2010-05-22 21:37:13 UTC (rev 1380) @@ -1,5 +1,12 @@ +include $(top_srcdir)/build/vars.build.mk +plugin = geanygendoc -lib_LTLIBRARIES = geanygendoc.la +if ENABLE_GEANYGENDOC +geanyplugins_LTLIBRARIES = geanygendoc.la +else +EXTRA_LTLIBRARIES = geanygendoc.la +endif + geanygendoc_la_SOURCES = ggd.c \ ggd-doc-setting.c \ ggd-doc-type.c \ @@ -25,18 +32,13 @@ ggd-utils.h \ ggd-widget-frame.h \ ggd-widget-doctype-selector.h -geanygendoc_la_LDFLAGS = -module -avoid-version -geanygendoc_la_LIBADD = @GEANY_LIBS@ \ +geanygendoc_la_CFLAGS = $(AM_CFLAGS) \ + @GLIB_CFLAGS@ \ + @GIO_CFLAGS@ \ + @GTK_CFLAGS@ \ + @CTPL_CFLAGS@ +geanygendoc_la_LIBADD = $(COMMONLIBS) \ @GLIB_LIBS@ \ @GIO_LIBS@ \ @GTK_LIBS@ \ - @CTPL_LIBS@ \ - $(INTLLIBS) - -AM_CFLAGS = @GEANY_CFLAGS@ \ - @GLIB_CFLAGS@ \ - @GIO_CFLAGS@ \ - @GTK_CFLAGS@ \ - @CTPL_CFLAGS@ \ - -DLOCALEDIR=\""$(localedir)"\" \ - -DDOCDIR=\""$(docdir)/"\" + @CTPL_LIBS@ Modified: trunk/geany-plugins/geanygendoc/src/ggd-plugin.c =================================================================== --- trunk/geanygendoc/src/ggd-plugin.c 2010-05-22 12:48:44 UTC (rev 1379) +++ trunk/geany-plugins/geanygendoc/src/ggd-plugin.c 2010-05-22 21:37:13 UTC (rev 1380) @@ -311,7 +311,7 @@ open_manual_handler (GtkWidget *widget, gpointer data) { - utils_open_browser (DOCDIR "manual.html"); + utils_open_browser (DOCDIR "/" GGD_PLUGIN_CNAME "/manual.html"); } /* handler that reloads the configuration */ Modified: trunk/geany-plugins/geanygendoc/src/ggd-plugin.h =================================================================== --- trunk/geanygendoc/src/ggd-plugin.h 2010-05-22 12:48:44 UTC (rev 1379) +++ trunk/geany-plugins/geanygendoc/src/ggd-plugin.h 2010-05-22 21:37:13 UTC (rev 1380) @@ -47,7 +47,7 @@ #define GGD_PLUGIN_ONAME geanygendoc -#define GGD_PLUGIN_CNAME PACKAGE_TARNAME +#define GGD_PLUGIN_CNAME G_STRINGIFY (GGD_PLUGIN_ONAME) #define GGD_PLUGIN_NAME "GeanyGenDoc" Modified: trunk/geany-plugins/po/POTFILES.in =================================================================== --- trunk/geany-plugins/po/POTFILES.in 2010-05-22 12:48:44 UTC (rev 1379) +++ trunk/geany-plugins/po/POTFILES.in 2010-05-22 21:37:13 UTC (rev 1380) @@ -33,6 +33,20 @@ geanygdb/src/gdb-ui-main.c geanygdb/src/geanygdb.c +# GeanyGenDoc +geanygendoc/src/ggd.c +geanygendoc/src/ggd-doc-setting.c +geanygendoc/src/ggd-doc-type.c +geanygendoc/src/ggd-file-type.c +geanygendoc/src/ggd-file-type-loader.c +geanygendoc/src/ggd-file-type-manager.c +geanygendoc/src/ggd-options.c +geanygendoc/src/ggd-plugin.c +geanygendoc/src/ggd-tag-utils.c +geanygendoc/src/ggd-utils.c +geanygendoc/src/ggd-widget-doctype-selector.c +geanygendoc/src/ggd-widget-frame.c + #geanylatex geanylatex/src/bibtex.c geanylatex/src/formatutils.c This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

1 0

SF.net SVN: geany-plugins:[1379] trunk/geanygendoc/src/ggd-plugin.c
by colombanw＠users.sourceforge.net 22 May '10

22 May '10

Revision: 1379 http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1379&view=rev Author: colombanw Date: 2010-05-22 12:48:44 +0000 (Sat, 22 May 2010) Log Message: ----------- GeanyGenDoc: Fix some packing in preferences dialog Fix packing of the General frame not to expand unnecessarily, which would break other expansions. Modified Paths: -------------- trunk/geanygendoc/src/ggd-plugin.c Modified: trunk/geanygendoc/src/ggd-plugin.c =================================================================== --- trunk/geanygendoc/src/ggd-plugin.c 2010-05-22 12:48:12 UTC (rev 1378) +++ trunk/geanygendoc/src/ggd-plugin.c 2010-05-22 12:48:44 UTC (rev 1379) @@ -560,7 +560,7 @@ /* General */ frame = ggd_frame_new (_("General")); - gtk_box_pack_start (GTK_BOX (box), frame, TRUE, TRUE, 0); + gtk_box_pack_start (GTK_BOX (box), frame, FALSE, FALSE, 0); box2 = gtk_vbox_new (FALSE, 0); gtk_container_add (GTK_CONTAINER (frame), box2); /* auto-save */ This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

1 0

SF.net SVN: geany-plugins:[1378] trunk/geanygendoc/TODO
by colombanw＠users.sourceforge.net 22 May '10

22 May '10

Revision: 1378 http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1378&view=rev Author: colombanw Date: 2010-05-22 12:48:12 +0000 (Sat, 22 May 2010) Log Message: ----------- GeanyGenDoc: Add an entry in the TODO-list Modified Paths: -------------- trunk/geanygendoc/TODO Modified: trunk/geanygendoc/TODO =================================================================== --- trunk/geanygendoc/TODO 2010-05-22 07:20:14 UTC (rev 1377) +++ trunk/geanygendoc/TODO 2010-05-22 12:48:12 UTC (rev 1378) @@ -14,3 +14,6 @@ * Store doctype in a per-document basis? It would be cool, but not sure it is possible without re-implementing a lot of document history. + +* Add a pop-up menu to the document type selector for common actions (edit, + clear, etc.). This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.

1 0

← Newer
1
2
3
4
5
6
7
8
9
10
Older →

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

Plugins-Commits May 2010