Plugins-Commits May 2010

plugins-commits@lists.geany.org

7 participants
98 discussions

SF.net SVN: geany-plugins:[1337] trunk/geanygendoc/docs/help/manual.rst
by colombanw＠users.sourceforge.net 09 May '10

09 May '10

Revision: 1337 http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1337&view=rev Author: colombanw Date: 2010-05-09 18:34:51 +0000 (Sun, 09 May 2010) Log Message: ----------- GeanyGenDoc: Clarify the manual by saying for what the syntax is used Modified Paths: -------------- trunk/geanygendoc/docs/help/manual.rst Modified: trunk/geanygendoc/docs/help/manual.rst =================================================================== --- trunk/geanygendoc/docs/help/manual.rst 2010-05-05 21:11:20 UTC (rev 1336) +++ trunk/geanygendoc/docs/help/manual.rst 2010-05-09 18:34:51 UTC (rev 1337) @@ -49,8 +49,9 @@ Key-Value pairs --------------- -The syntax is an extended key-value tree definition based on common concepts -(trees, string literals, semicolon-ended values, etc.). +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.). The key-value syntax is as follows:: 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:[1336] trunk/geanylatex/src/latexenvironments.c
by frlan＠users.sourceforge.net 05 May '10

05 May '10

Revision: 1336 http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1336&view=rev Author: frlan Date: 2010-05-05 21:11:20 +0000 (Wed, 05 May 2010) Log Message: ----------- GeanyLaTeX: Respect indention on inserting environment Modified Paths: -------------- trunk/geanylatex/src/latexenvironments.c Modified: trunk/geanylatex/src/latexenvironments.c =================================================================== --- trunk/geanylatex/src/latexenvironments.c 2010-05-05 21:10:29 UTC (rev 1335) +++ trunk/geanylatex/src/latexenvironments.c 2010-05-05 21:11:20 UTC (rev 1336) @@ -92,11 +92,13 @@ } else { - gint pos = sci_get_current_position(doc->editor->sci); - gint len = strlen(environment); + gint indent, pos, len; GString *tmpstring = NULL; gchar *tmp = NULL; + pos = sci_get_current_position(doc->editor->sci); + len = strlen(environment); + sci_start_undo_action(doc->editor->sci); tmpstring = g_string_new("\\begin{"); @@ -122,8 +124,15 @@ glatex_insert_string(tmp, TRUE); g_free(tmp); + indent = sci_get_line_indentation(doc->editor->sci, + sci_get_line_from_position(doc->editor->sci, pos)); + tmp = g_strdup_printf("\n\\end{%s}\n", environment); glatex_insert_string(tmp, FALSE); + + sci_set_line_indentation(doc->editor->sci, + sci_get_current_line(doc->editor->sci) + 1, indent); + g_free(tmp); sci_end_undo_action(doc->editor->sci); 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:[1335] trunk/geanylatex/src/geanylatex.c
by frlan＠users.sourceforge.net 05 May '10

05 May '10

Revision: 1335 http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1335&view=rev Author: frlan Date: 2010-05-05 21:10:29 +0000 (Wed, 05 May 2010) Log Message: ----------- GeanyLaTeX: Remove debug output Modified Paths: -------------- trunk/geanylatex/src/geanylatex.c Modified: trunk/geanylatex/src/geanylatex.c =================================================================== --- trunk/geanylatex/src/geanylatex.c 2010-05-04 22:36:53 UTC (rev 1334) +++ trunk/geanylatex/src/geanylatex.c 2010-05-05 21:10:29 UTC (rev 1335) @@ -502,7 +502,6 @@ end_construct = g_strdup_printf("\\end%s{%s}", full_cmd, env); if (strstr(tmp, end_construct) != NULL) { - g_warning ("was gefunden"); /* Clean up everything and quit as nothing * needs to be done */ g_free(tmp); @@ -524,9 +523,8 @@ construct = g_strdup_printf("\t\n\\end%s{%s}", full_cmd, env); editor_insert_text_block(editor, construct, pos, 1, -1, TRUE); - sci_set_line_indentation( - sci, - sci_get_current_line(sci) + 1, + /* ... and setting the indention */ + sci_set_line_indentation(sci, sci_get_current_line(sci) + 1, indent); g_free(construct); } 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:[1334] trunk/geanygendoc/src
by colombanw＠users.sourceforge.net 05 May '10

05 May '10

Revision: 1334 http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1334&view=rev Author: colombanw Date: 2010-05-04 22:36:53 +0000 (Tue, 04 May 2010) Log Message: ----------- GeanyGenDoc: Add a menu item to open the manual Modified Paths: -------------- trunk/geanygendoc/src/Makefile.am trunk/geanygendoc/src/ggd-plugin.c Modified: trunk/geanygendoc/src/Makefile.am =================================================================== --- trunk/geanygendoc/src/Makefile.am 2010-05-04 20:48:19 UTC (rev 1333) +++ trunk/geanygendoc/src/Makefile.am 2010-05-04 22:36:53 UTC (rev 1334) @@ -36,4 +36,5 @@ @GIO_CFLAGS@ \ @GTK_CFLAGS@ \ @CTPL_CFLAGS@ \ - -DLOCALEDIR=\""$(localedir)"\" + -DLOCALEDIR=\""$(localedir)"\" \ + -DDOCDIR=\""$(docdir)/"\" Modified: trunk/geanygendoc/src/ggd-plugin.c =================================================================== --- trunk/geanygendoc/src/ggd-plugin.c 2010-05-04 20:48:19 UTC (rev 1333) +++ trunk/geanygendoc/src/ggd-plugin.c 2010-05-04 22:36:53 UTC (rev 1334) @@ -261,6 +261,13 @@ } } +static void +open_manual_handler (GtkWidget *widget, + gpointer data) +{ + utils_open_browser (DOCDIR "manual.html"); +} + /* handler that reloads the configuration */ static void reload_configuration_hanlder (GtkWidget *widget, @@ -377,6 +384,17 @@ G_CALLBACK (open_current_filetype_conf_handler), NULL); gtk_menu_shell_append (GTK_MENU_SHELL (menu), item); ui_add_document_sensitive (item); + /* separator */ + item = gtk_separator_menu_item_new (); + gtk_menu_shell_append (GTK_MENU_SHELL (menu), item); + /* help/manual opening */ + item = gtk_image_menu_item_new_with_mnemonic (_("Open _manual")); + ui_widget_set_tooltip_text (item, _("Open the manual in a browser")); + gtk_image_menu_item_set_image (GTK_IMAGE_MENU_ITEM (item), + gtk_image_new_from_stock (GTK_STOCK_HELP, + GTK_ICON_SIZE_MENU)); + g_signal_connect (item, "activate", G_CALLBACK (open_manual_handler), NULL); + gtk_menu_shell_append (GTK_MENU_SHELL (menu), item); /* build tools menu item */ item = gtk_menu_item_new_with_mnemonic (_("_Documentation generator")); gtk_menu_item_set_submenu (GTK_MENU_ITEM (item), menu); 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:[1333] trunk/geanygendoc
by colombanw＠users.sourceforge.net 04 May '10

04 May '10

Revision: 1333 http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1333&view=rev Author: colombanw Date: 2010-05-04 20:48:19 +0000 (Tue, 04 May 2010) Log Message: ----------- GeanyGenDoc: Add and install documentation Add a manual and install it (and other missing documentation files). Modified Paths: -------------- trunk/geanygendoc/Makefile.am trunk/geanygendoc/README.in trunk/geanygendoc/configure.ac Added Paths: ----------- trunk/geanygendoc/docs/ trunk/geanygendoc/docs/Makefile.am trunk/geanygendoc/docs/help/ trunk/geanygendoc/docs/help/Makefile.am trunk/geanygendoc/docs/help/html4css1.css trunk/geanygendoc/docs/help/manual.css trunk/geanygendoc/docs/help/manual.rst Modified: trunk/geanygendoc/Makefile.am =================================================================== --- trunk/geanygendoc/Makefile.am 2010-05-03 22:53:23 UTC (rev 1332) +++ trunk/geanygendoc/Makefile.am 2010-05-04 20:48:19 UTC (rev 1333) @@ -1,5 +1,5 @@ -SUBDIRS = src data po +SUBDIRS = src data po docs ACLOCAL_AMFLAGS = -I build/m4 @@ -7,6 +7,10 @@ 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 Modified: trunk/geanygendoc/README.in =================================================================== --- trunk/geanygendoc/README.in 2010-05-03 22:53:23 UTC (rev 1332) +++ trunk/geanygendoc/README.in 2010-05-04 20:48:19 UTC (rev 1333) @@ -17,7 +17,11 @@ - A working make implementation (GNU make is recommended, http://www.gnu.org/software/make/) +You may also want the following packages that enables extra features: + - Docutils (http://docutils.sourceforge.net/) -- or another implementation of + rst2html -- is needed to (re)generate the HTML manual. + Installation ============ Modified: trunk/geanygendoc/configure.ac =================================================================== --- trunk/geanygendoc/configure.ac 2010-05-03 22:53:23 UTC (rev 1332) +++ trunk/geanygendoc/configure.ac 2010-05-04 20:48:19 UTC (rev 1333) @@ -18,6 +18,10 @@ LT_INIT([disable-static]) AC_PROG_INSTALL +AC_PATH_PROG([RST2HTML], [rst2html], [no]) +AC_SUBST([RST2HTML]) +AM_CONDITIONAL([BUILD_RST], [test "x$RST2HTML" != "xno"]) + # checking for Geany PKG_CHECK_MODULES(GEANY, [geany >= 0.18.1]) PKG_CHECK_MODULES(GTK, [gtk+-2.0 >= 2.12]) @@ -57,6 +61,8 @@ # 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([ @@ -66,6 +72,8 @@ data/Makefile data/filetypes/Makefile po/Makefile.in + docs/Makefile + docs/help/Makefile ]) AC_OUTPUT Added: trunk/geanygendoc/docs/Makefile.am =================================================================== --- trunk/geanygendoc/docs/Makefile.am (rev 0) +++ trunk/geanygendoc/docs/Makefile.am 2010-05-04 20:48:19 UTC (rev 1333) @@ -0,0 +1 @@ +SUBDIRS = help Added: trunk/geanygendoc/docs/help/Makefile.am =================================================================== --- trunk/geanygendoc/docs/help/Makefile.am (rev 0) +++ trunk/geanygendoc/docs/help/Makefile.am 2010-05-04 20:48:19 UTC (rev 1333) @@ -0,0 +1,14 @@ +EXTRA_DIST = manual.rst \ + manual.css \ + html4css1.css + +doc_DATA = + +if BUILD_RST +doc_DATA += manual.html + +EXTRA_DIST += manual.html + +manual.html: manual.rst manual.css + $(AM_V_GEN) $(RST2HTML) -d --strict --stylesheet-path manual.css $< $@ +endif BUILD_RST Added: trunk/geanygendoc/docs/help/html4css1.css =================================================================== --- trunk/geanygendoc/docs/help/html4css1.css (rev 0) +++ trunk/geanygendoc/docs/help/html4css1.css 2010-05-04 20:48:19 UTC (rev 1333) @@ -0,0 +1,293 @@ +/* +:Author: David Goodger (goodger(a)python.org) +:Id: $Id: html4css1.css 5951 2009-05-18 18:03:10Z milde $ +:Copyright: This stylesheet has been placed in the public domain. + +Default cascading style sheet for the HTML output of Docutils. + +See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to +customize this style sheet. +*/ + +/* used to remove borders from tables and images */ +.borderless, table.borderless td, table.borderless th { + border: 0 } + +table.borderless td, table.borderless th { + /* Override padding for "table.docutils td" with "! important". + The right padding separates the table cells. */ + padding: 0 0.5em 0 0 ! important } + +.first { + /* Override more specific margin styles with "! important". */ + margin-top: 0 ! important } + +.last, .with-subtitle { + margin-bottom: 0 ! important } + +.hidden { + display: none } + +a.toc-backref { + text-decoration: none ; + color: black } + +blockquote.epigraph { + margin: 2em 5em ; } + +dl.docutils dd { + margin-bottom: 0.5em } + +/* Uncomment (and remove this text!) to get bold-faced definition list terms +dl.docutils dt { + font-weight: bold } +*/ + +div.abstract { + margin: 2em 5em } + +div.abstract p.topic-title { + font-weight: bold ; + text-align: center } + +div.admonition, div.attention, div.caution, div.danger, div.error, +div.hint, div.important, div.note, div.tip, div.warning { + margin: 2em ; + border: medium outset ; + padding: 1em } + +div.admonition p.admonition-title, div.hint p.admonition-title, +div.important p.admonition-title, div.note p.admonition-title, +div.tip p.admonition-title { + font-weight: bold ; + font-family: sans-serif } + +div.attention p.admonition-title, div.caution p.admonition-title, +div.danger p.admonition-title, div.error p.admonition-title, +div.warning p.admonition-title { + color: red ; + font-weight: bold ; + font-family: sans-serif } + +/* Uncomment (and remove this text!) to get reduced vertical space in + compound paragraphs. +div.compound .compound-first, div.compound .compound-middle { + margin-bottom: 0.5em } + +div.compound .compound-last, div.compound .compound-middle { + margin-top: 0.5em } +*/ + +div.dedication { + margin: 2em 5em ; + text-align: center ; + font-style: italic } + +div.dedication p.topic-title { + font-weight: bold ; + font-style: normal } + +div.figure { + margin-left: 2em ; + margin-right: 2em } + +div.footer, div.header { + clear: both; + font-size: smaller } + +div.line-block { + display: block ; + margin-top: 1em ; + margin-bottom: 1em } + +div.line-block div.line-block { + margin-top: 0 ; + margin-bottom: 0 ; + margin-left: 1.5em } + +div.sidebar { + margin: 0 0 0.5em 1em ; + border: medium outset ; + padding: 1em ; + background-color: #ffffee ; + width: 40% ; + float: right ; + clear: right } + +div.sidebar p.rubric { + font-family: sans-serif ; + font-size: medium } + +div.system-messages { + margin: 5em } + +div.system-messages h1 { + color: red } + +div.system-message { + border: medium outset ; + padding: 1em } + +div.system-message p.system-message-title { + color: red ; + font-weight: bold } + +div.topic { + margin: 2em } + +h1.section-subtitle, h2.section-subtitle, h3.section-subtitle, +h4.section-subtitle, h5.section-subtitle, h6.section-subtitle { + margin-top: 0.4em } + +h1.title { + text-align: center } + +h2.subtitle { + text-align: center } + +hr.docutils { + width: 75% } + +img.align-left, .figure.align-left{ + clear: left ; + float: left ; + margin-right: 1em } + +img.align-right, .figure.align-right { + clear: right ; + float: right ; + margin-left: 1em } + +.align-left { + text-align: left } + +.align-center { + clear: both ; + text-align: center } + +.align-right { + text-align: right } + +/* reset inner alignment in figures */ +div.align-right { + text-align: left } + +/* div.align-center * { */ +/* text-align: left } */ + +ol.simple, ul.simple { + margin-bottom: 1em } + +ol.arabic { + list-style: decimal } + +ol.loweralpha { + list-style: lower-alpha } + +ol.upperalpha { + list-style: upper-alpha } + +ol.lowerroman { + list-style: lower-roman } + +ol.upperroman { + list-style: upper-roman } + +p.attribution { + text-align: right ; + margin-left: 50% } + +p.caption { + font-style: italic } + +p.credits { + font-style: italic ; + font-size: smaller } + +p.label { + white-space: nowrap } + +p.rubric { + font-weight: bold ; + font-size: larger ; + color: maroon ; + text-align: center } + +p.sidebar-title { + font-family: sans-serif ; + font-weight: bold ; + font-size: larger } + +p.sidebar-subtitle { + font-family: sans-serif ; + font-weight: bold } + +p.topic-title { + font-weight: bold } + +pre.address { + margin-bottom: 0 ; + margin-top: 0 ; + font: inherit } + +pre.literal-block, pre.doctest-block { + margin-left: 2em ; + margin-right: 2em } + +span.classifier { + font-family: sans-serif ; + font-style: oblique } + +span.classifier-delimiter { + font-family: sans-serif ; + font-weight: bold } + +span.interpreted { + font-family: sans-serif } + +span.option { + white-space: nowrap } + +span.pre { + white-space: pre } + +span.problematic { + color: red } + +span.section-subtitle { + /* font-size relative to parent (h1..h6 element) */ + font-size: 80% } + +table.citation { + border-left: solid 1px gray; + margin-left: 1px } + +table.docinfo { + margin: 2em 4em } + +table.docutils { + margin-top: 0.5em ; + margin-bottom: 0.5em } + +table.footnote { + border-left: solid 1px black; + margin-left: 1px } + +table.docutils td, table.docutils th, +table.docinfo td, table.docinfo th { + padding-left: 0.5em ; + padding-right: 0.5em ; + vertical-align: top } + +table.docutils th.field-name, table.docinfo th.docinfo-name { + font-weight: bold ; + text-align: left ; + white-space: nowrap ; + padding-left: 0 } + +h1 tt.docutils, h2 tt.docutils, h3 tt.docutils, +h4 tt.docutils, h5 tt.docutils, h6 tt.docutils { + font-size: 100% } + +ul.auto-toc { + list-style-type: none } Added: trunk/geanygendoc/docs/help/manual.css =================================================================== --- trunk/geanygendoc/docs/help/manual.css (rev 0) +++ trunk/geanygendoc/docs/help/manual.css 2010-05-04 20:48:19 UTC (rev 1333) @@ -0,0 +1,68 @@ +/* +: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; +} Added: trunk/geanygendoc/docs/help/manual.rst =================================================================== --- trunk/geanygendoc/docs/help/manual.rst (rev 0) +++ trunk/geanygendoc/docs/help/manual.rst 2010-05-04 20:48:19 UTC (rev 1333) @@ -0,0 +1,452 @@ +======================= +GeanyGenDoc User Manual +======================= +------------------------------------------------- +A handy hand guide for the lazy documenter in you +------------------------------------------------- + + +Introduction +============ + +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. + + +.. contents:: + + +Design +====== + +GeanyGenDoc has an extensible design based on three points: file type, +documentation type and rules. + +`File type`_ + The file type determines which configuration applies to which document. For + example, the "c" file type corresponds to C source, and so on. + +`Documentation type`_ + 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 `Doxygen`_ + and `Gtk-Doc`_ documentation from C sources. She should then create two + documentation types in the C `file type configuration file`_, such as + "doxygen" and "gtkdoc". + +`Rule`_ + 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. + + +Syntax +====== + +Key-Value pairs +--------------- + +The syntax is an extended key-value tree definition based on common concepts +(trees, string literals, semicolon-ended values, etc.). + +The key-value syntax is as follows:: + + key = value + +where value is either a semicolon-ended single value:: + + value; + +or a brace-surrounded list of key-value pairs that use the same syntax again:: + + { + key1 = value1 + key2 = value2 + } + +Here a little example of the *syntax* (not any actual configuration example):: + + key1 = value1; + key2 = { + sub-key1 = sub-value1; + sub-key2 = { + sub-sub-key1 = sub-sub-value1; + } + } + + +Naming +------ + +Key-value pairs are often referred as *group* when they are meant to have +multiple values and as *setting* when they have a single value. + + +Comments +-------- + +Is considered as comment (and therefore ignored) everything between a number +sign (``#``) and the following end of line, unless the ``#`` occurs as part of +another syntactic element (such as a string literal). + +A short example:: + + # This is a comment + key = value; # This is also a comment + string = "A string. # This isn't a comment but a string"; + + +Value types +----------- + +string + A string literal. String literals are surrounded by either single (``'``) or + double (``"``) quotes. + + Some special characters can be inserted in a string with an escape sequence: + + ``\t`` + A tabulation. + ``\n`` + A new line. + ``\r`` + A carriage return. + ``\\`` + A backslash. + ``\'`` + A single quote (escaping only needed in single-quotes surrounded strings). + ``\"`` + A double quote (escaping only needed in double-quotes surrounded strings). + + Note that backslashes are used as the escaping character, which means that it + must be escaped to be treated as a simple backslash character. + + A simple example:: + + "This is a string with \"special\" characters.\nThis is another line!" + +boolean + A boolean. It can take one of the two symbolic values ``True`` and ``False``. + +enumeration + An enumeration. It consists of a named constant, generally in capital letters. + The possible values depend on the setting that use this type. + +flags + A logical OR of named constants. This is like enumerations but can combine + different values. + + The syntax is common for such types and uses the pipe (``|``) as + combination character. Considering the ``A``, ``B`` and ``C`` constants, a + valid value could be ``A | C``, which represents both ``A`` and ``C`` but + not ``B``. + +list + A list of values (often referred as array). + + +File types +========== + +The file type determines which configuration applies to which document. +*File type identifiers* are the lowercased name of the Geany's file type, for +example "c" or "python". + +Configuration for a particular file type goes in a file named +``file-type-identifier.conf`` in the ``filetypes`` sub-directory of a +`configuration directory`_. + +A file type configuration can contain two type of things: file-type-wide +settings and any number of `documentation types`_. + + +The ``settings`` group +---------------------- + +This group contains the file-type-wide settings. + +``match_function_arguments`` (string) + 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. + +``global_environment`` (string) + A description of a CTPL_ environment to add when parsing rule_'s templates. + + +The ``doctypes`` group +---------------------- + +This group contains a list of `documentation types`_. + + +Documentation types +=================== + +A documentation type is a named set of rules_ for a `file type`_, describing how +to generate a particular type of documentation (i.e. Doxygen_, `Gtk-Doc`_, +Valadoc_ or whatever). + +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). + + +Short example +------------- + +:: + + doxygen = { + struct.member = { + template = " /**< {cursor} */"; + position = AFTER; + } + struct.template = "/**\n * @brief: {cursor}\n * \n * \n */\n"; + } + + +Rules: the cool thing +===================== + +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. + +A rule is represented as a group of `settings`_ in a `documentation type`_. +The name of this group is the `type hierarchy`_ to which the settings applies. + + +Type hierarchy +-------------- + +A type hierarchy is a hierarchy of the types that a symbol must have to match +this rule. + +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 ``class -> method``; and if the class is itself in a +namespace, the hierarchy would the look like ``namespace -> class -> method``, +and so on. + +For a rule to apply, its type hierarchy must match *the end* of the symbol +type hierarchy. For example a rule with the type hierarchy ``class`` will match +a symbol with the type hierarchy ``namespace -> class`` but not one with +``class -> method``. + +A type hierarchy uses dots (``.``) to separate types and build the hierarchy. +For example, the type hierarchy representing ``namespace -> class`` would be +written ``namespace.class``. + + +Known types +~~~~~~~~~~~ + +``class`` + A class. +``enum`` + An enumeration. +``enumval`` + An enumeration value. +``field`` + A field (of a class for example). +``function`` + A function. +``interface`` + An interface. +``member`` + A member (of a structure for example). +``method`` + A method. +``namespace`` + A namespace. +``package`` + A package. +``prototype`` + A prototype. +``struct`` + A structure. +``typedef`` + A type alias definition (*typedef* in C). +``union`` + An union. +``variable`` + A variable. +``extern`` + `???` +``define`` + A definition (like the *define* C preprocessor macro). +``macro`` + A macro. +``file`` + A file (will never match). + + +Rule settings +------------- + +``template`` (string) + A CTPL_ template that can include references to the following predefined + variables in addition to the file-type-wide and the global environment: + + ``argument_list`` (string list) + A list of the arguments of the currently documented symbol. + + ``returns`` (boolean) + Indicates whether the currently documented symbol returns a value + (makes sense only for symbols that may return a value). + + ``children`` (string list) + A list of the current symbol's first-level children. This is only set if + the rule's setting ``children`` is set to ``MERGE``. + + **[...]** + + ``cursor`` (special, described below) + 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. + +``position`` (enumeration) + The position where the documentation should be inserted. Possible values are: + + ``BEFORE`` [default]_ + Inserts the documentation just before the symbol. + + ``AFTER`` + Inserts the documentation just after the symbol (currently quite limited, it + inserts the documentation at the end of the symbol's first line). + + ``CURSOR`` + Inserts the documentation at the current cursor position. + +``policy`` (enumeration) + How the symbol is documented. Possible values are: + + ``KEEP`` [default]_ + The symbol documents itself. + + ``FORWARD`` + Forward the documentation request to the parent. This is useful for symbols + that are documented by their parent, such as `Gtk-Doc`_'s enumerations. + +``children`` (enumeration) + How the symbol's children can be used in the template. Possible values are: + + ``SPLIT`` [default]_ + The symbol's children are provided as per-type lists. + + ``MERGE`` + The symbol's children are provided as a single list named ``children``. + +``matches`` (flags) + List of the children types that should be provided. Only useful if the + ``children`` setting is set to ``MERGE``. + Defaults to all. + **FIXME: check the exactitude of this description** + +``auto_doc_children`` (boolean) + Whether to also document symbol's children (according to their own rules). + + +Miscellaneous +============= + +Configuration directories +------------------------- + +Configuration directories hold GeanyGenDoc's configuration. They are the +following: + +* + The user-specific configuration directory, containing the user-defined + settings is ``$GEANY_USER_CONFIG/plugins/geanygendoc/``. + ``$GEANY_USER_CONFIG`` is generally ``~/.config/geany/`` on UNIX systems. +* + The system-wide configuration directory containing the default and + pre-installed configuration is ``$GEANY_SYS_CONFIG/plugins/geanygendoc/``. + ``$GEANY_SYS_CONFIG`` is generally ``/usr/share/geany/`` or + ``/usr/local/share/geany`` on UNIX systems. + +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. + + +Appendix +======== + +Configuration syntax summary +---------------------------- + +:: + + 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? ) + + +.. Content end, begin references + +.. External links +.. +.. _Doxygen: http://www.doxygen.org +.. _Gtk-Doc: http://www.gtk.org/gtk-doc/ +.. _Valadoc: http://www.valadoc.org/ +.. _CTPL: http://ctpl.tuxfamily.org/ + +.. Internal links +.. +.. _file type: `File types`_ +.. _file type configuration file: `File types`_ +.. _documentation type: `Documentation types`_ +.. _rule: `Rules: the cool thing`_ +.. _rules: `Rules: the cool thing`_ +.. _settings: `Rule settings`_ +.. _configuration directory: `Configuration directories`_ + +------------------- + +.. [default] This is the default value of the setting 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:[1332] trunk/geanylatex
by frlan＠users.sourceforge.net 04 May '10

04 May '10

Revision: 1332 http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1332&view=rev Author: frlan Date: 2010-05-03 22:53:23 +0000 (Mon, 03 May 2010) Log Message: ----------- GeanyLaTeX: Make usage of plugin API v184 Modified Paths: -------------- trunk/geanylatex/INSTALL trunk/geanylatex/doc/geanylatex.tex trunk/geanylatex/src/geanylatex.c Modified: trunk/geanylatex/INSTALL =================================================================== --- trunk/geanylatex/INSTALL 2010-05-03 22:52:50 UTC (rev 1331) +++ trunk/geanylatex/INSTALL 2010-05-03 22:53:23 UTC (rev 1332) @@ -1,7 +1,7 @@ These installation instructions are written for a Linux system, but should work also on other plattforms as Windows is. -Building the plugin requires Geany 0.19 or above (Geany Plugin API v170 +Building the plugin requires Geany 0.19 or above (Geany Plugin API v184 or higher). You need for compliling the plugin the Geany header files installed. Modified: trunk/geanylatex/doc/geanylatex.tex =================================================================== --- trunk/geanylatex/doc/geanylatex.tex 2010-05-03 22:52:50 UTC (rev 1331) +++ trunk/geanylatex/doc/geanylatex.tex 2010-05-03 22:53:23 UTC (rev 1332) @@ -152,7 +152,7 @@ you used a prepared package e.g. from your distribution you probably need to install an additional package, this might be called geany-dev or geany-devel. Please note that in order to compile and use this -plugin, you need Geany 0.19svn or later (Geany Plugin API v170 or higher). +plugin, you need Geany 0.19svn or later (Geany Plugin API v184 or higher). Furthermore you need, of course, a C compiler and python installed. The GNU version of the C compiler is recommended. Also there should be a Modified: trunk/geanylatex/src/geanylatex.c =================================================================== --- trunk/geanylatex/src/geanylatex.c 2010-05-03 22:52:50 UTC (rev 1331) +++ trunk/geanylatex/src/geanylatex.c 2010-05-03 22:53:23 UTC (rev 1332) @@ -28,7 +28,7 @@ #include "geanylatex.h" #include "ctype.h" -PLUGIN_VERSION_CHECK(170) +PLUGIN_VERSION_CHECK(184) PLUGIN_SET_INFO(_("GeanyLaTeX"), _("Plugin to provide better LaTeX support"), VERSION,"Frank Lanitz <frank(a)frank.uvena.de>") @@ -437,12 +437,13 @@ if (sci_get_char_at(sci, pos - (editor_get_eol_char_len (editor) + 1)) == '}'|| sci_get_char_at(sci, pos - (editor_get_eol_char_len (editor) + 1)) == ']') { - gchar *buf, *construct, *indent; + gchar *buf, *construct; /* TODO: Make possible to have longer than a 50 chars environment */ gchar env[50]; gint line = sci_get_line_from_position(sci, pos - (editor_get_eol_char_len (editor) + 1)); gint line_len = sci_get_line_length(sci, line); gint i, start; + gint indent; /* get the line */ buf = sci_get_line(sci, line); @@ -516,15 +517,18 @@ /* After we have this, we need to ensure basic * indent is getting applied on closing command */ - indent = g_strndup(buf, start); + indent = sci_get_line_indentation(sci, line); /* Now we build up closing string and insert * it into document */ - construct = g_strdup_printf("\t\n%s\\end%s{%s}", indent, full_cmd, env); + construct = g_strdup_printf("\t\n\\end%s{%s}", full_cmd, env); editor_insert_text_block(editor, construct, pos, 1, -1, TRUE); + sci_set_line_indentation( + sci, + sci_get_current_line(sci) + 1, + indent); g_free(construct); - g_free(indent); } } break; 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:[1331] trunk/geanylatex/TODO
by frlan＠users.sourceforge.net 04 May '10

04 May '10

Revision: 1331 http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1331&view=rev Author: frlan Date: 2010-05-03 22:52:50 +0000 (Mon, 03 May 2010) Log Message: ----------- GeanyLaTeX: Extend TODO list by minor item Modified Paths: -------------- trunk/geanylatex/TODO Modified: trunk/geanylatex/TODO =================================================================== --- trunk/geanylatex/TODO 2010-05-01 18:12:33 UTC (rev 1330) +++ trunk/geanylatex/TODO 2010-05-03 22:52:50 UTC (rev 1331) @@ -17,6 +17,8 @@ * Adding a way setting variables/values for wizard inside custom template * Cleaning up the mess with KOMA/non KOMA classes + * Replacing & by \& inside title and author on wizard screen as most + likely user is not inserting any tabular there * Replacing of environments * Parsing document for »TOC« * Navigation throught document 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:[1330] trunk/geanygendoc/src/ggd.c
by colombanw＠users.sourceforge.net 01 May '10

01 May '10

Revision: 1330 http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1330&view=rev Author: colombanw Date: 2010-05-01 18:12:33 +0000 (Sat, 01 May 2010) Log Message: ----------- GeanyGenDoc: 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. Modified Paths: -------------- trunk/geanygendoc/src/ggd.c Modified: trunk/geanygendoc/src/ggd.c =================================================================== --- trunk/geanygendoc/src/ggd.c 2010-05-01 17:49:41 UTC (rev 1329) +++ trunk/geanygendoc/src/ggd.c 2010-05-01 18:12:33 UTC (rev 1330) @@ -146,19 +146,16 @@ GeanyDocument *doc, const TMTag *tag) { - CtplEnviron *env; - GList *children = NULL; - GPtrArray *tag_array = doc->tm_file->tags_array; + CtplEnviron *env; + GList *children = NULL; + GPtrArray *tag_array = doc->tm_file->tags_array; + gboolean returns; env = ctpl_environ_new (); ctpl_environ_push_string (env, "cursor", GGD_CURSOR_IDENTIFIER); ctpl_environ_push_string (env, "symbol", tag->name); - /* get arguments & return type if appropriate */ - if (tag->type & (tm_tag_function_t | - tm_tag_macro_with_arg_t | - tm_tag_prototype_t | - tm_tag_method_t)) { - gboolean returns; + /* get argument list it it exists */ + if (tag->atts.entry.arglist) { CtplValue *v; v = get_arg_list_from_string (ft, tag->atts.entry.arglist); @@ -166,11 +163,13 @@ ctpl_environ_push (env, "argument_list", v); ctpl_value_free (v); } - returns = ! (tag->atts.entry.var_type != NULL && - /* C-style none return type hack */ - strcmp ("void", tag->atts.entry.var_type) == 0); - ctpl_environ_push_int (env, "returns", returns); } + /* get return type -- no matter if the return concept is pointless for that + * particular tag, it's up to the rule to use it when it makes sense */ + returns = ! (tag->atts.entry.var_type != NULL && + /* C-style none return type hack */ + strcmp ("void", tag->atts.entry.var_type) == 0); + ctpl_environ_push_int (env, "returns", returns); /* get direct children tags */ children = ggd_tag_find_children (tag_array, tag, FILETYPE_ID (doc->file_type), 0); 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:[1329] trunk/geanygendoc/src
by colombanw＠users.sourceforge.net 01 May '10

01 May '10

Revision: 1329 http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1329&view=rev Author: colombanw Date: 2010-05-01 17:49:41 +0000 (Sat, 01 May 2010) Log Message: ----------- GeanyGenDoc: Implement and use Glade-style frames This makes the UI quite nicer and more consistent with both Geany and GNOME. Modified Paths: -------------- trunk/geanygendoc/src/Makefile.am trunk/geanygendoc/src/ggd-plugin.c Added Paths: ----------- trunk/geanygendoc/src/ggd-widget-frame.c trunk/geanygendoc/src/ggd-widget-frame.h Modified: trunk/geanygendoc/src/Makefile.am =================================================================== --- trunk/geanygendoc/src/Makefile.am 2010-05-01 17:49:07 UTC (rev 1328) +++ trunk/geanygendoc/src/Makefile.am 2010-05-01 17:49:41 UTC (rev 1329) @@ -9,7 +9,8 @@ ggd-tag-utils.c \ ggd-options.c \ ggd-plugin.c \ - ggd-utils.c + ggd-utils.c \ + ggd-widget-frame.c noinst_HEADERS = ggd.h \ ggd-doc-setting.h \ ggd-doc-type.h \ @@ -20,7 +21,8 @@ ggd-macros.h \ ggd-options.h \ ggd-plugin.h \ - ggd-utils.h + ggd-utils.h \ + ggd-widget-frame.h geanygendoc_la_LDFLAGS = -module -avoid-version geanygendoc_la_LIBADD = @GEANY_LIBS@ \ @GLIB_LIBS@ \ Modified: trunk/geanygendoc/src/ggd-plugin.c =================================================================== --- trunk/geanygendoc/src/ggd-plugin.c 2010-05-01 17:49:07 UTC (rev 1328) +++ trunk/geanygendoc/src/ggd-plugin.c 2010-05-01 17:49:41 UTC (rev 1329) @@ -424,6 +424,8 @@ /* --- Configuration dialog --- */ +#include "ggd-widget-frame.h" + static void conf_dialog_response_handler (GtkDialog *dialog, gint response_id, @@ -483,7 +485,7 @@ widget); gtk_box_pack_start (GTK_BOX (box), widget, FALSE, FALSE, 0); /* environ editor */ - widget = gtk_frame_new (_("Global environment")); + widget = ggd_frame_new (_("Global environment")); ui_widget_set_tooltip_text (widget, _("Global environment overrides and " "additions. This environment will be " "merged with the filetype-specific " Added: trunk/geanygendoc/src/ggd-widget-frame.c =================================================================== --- trunk/geanygendoc/src/ggd-widget-frame.c (rev 0) +++ trunk/geanygendoc/src/ggd-widget-frame.c 2010-05-01 17:49:41 UTC (rev 1329) @@ -0,0 +1,119 @@ +/* + * + * GeanyGenDoc, a Geany plugin to ease generation of source code documentation + * Copyright (C) 2010 Colomban Wendling <ban(a)herbesfolles.org> + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + * + */ + +/* + * A GtkFrame subclass that reproduce Glade's frames. + */ + +#include <gtk/gtk.h> + +#include "ggd-widget-frame.h" + + +struct _GgdFramePrivate +{ + PangoAttrList *label_attr_list; + GtkWidget *alignment; +}; + + +G_DEFINE_TYPE (GgdFrame, ggd_frame, GTK_TYPE_FRAME) + + +static void +ggd_frame_add (GtkContainer *container, + GtkWidget *child) +{ + GgdFrame *self = GGD_FRAME (container); + + /* chain additions to the alignment if we aren't adding it */ + if (child == self->priv->alignment) { + GTK_CONTAINER_CLASS (ggd_frame_parent_class)->add (container, child); + } else { + container = GTK_CONTAINER (self->priv->alignment); + GTK_CONTAINER_GET_CLASS (container)->add (container, child); + } +} + +static void +ggd_frame_finalize (GObject *object) +{ + GgdFrame *self = GGD_FRAME (object); + + pango_attr_list_unref (self->priv->label_attr_list); + + G_OBJECT_CLASS (ggd_frame_parent_class)->finalize (object); +} + +static void +ggd_frame_class_init (GgdFrameClass *klass) +{ + GObjectClass *object_class = G_OBJECT_CLASS (klass); + GtkContainerClass *container_class = GTK_CONTAINER_CLASS (klass); + + object_class->finalize = ggd_frame_finalize; + container_class->add = ggd_frame_add; + + g_type_class_add_private (klass, sizeof (GgdFramePrivate)); +} + +static void +ggd_frame_label_notify (GObject *object, + GParamSpec *pspec, + gpointer data) +{ + GgdFrame *self = GGD_FRAME (object); + GtkWidget *label; + + label = gtk_frame_get_label_widget (GTK_FRAME (self)); + if (label) { + gtk_label_set_attributes (GTK_LABEL (label), self->priv->label_attr_list); + } +} + +static void +ggd_frame_init (GgdFrame *self) +{ + self->priv = G_TYPE_INSTANCE_GET_PRIVATE (self, + GGD_FRAME_TYPE, + GgdFramePrivate); + + /* set-up the frame attributes */ + gtk_frame_set_shadow_type (GTK_FRAME (self), GTK_SHADOW_NONE); + /* set-up fake child */ + self->priv->alignment = gtk_alignment_new (0.5, 0.5, 1.0, 1.0); + gtk_alignment_set_padding (GTK_ALIGNMENT(self->priv->alignment), 0, 0, 12, 0); + gtk_container_add (GTK_CONTAINER (self), self->priv->alignment); + gtk_widget_show (self->priv->alignment); + /* set-up the label's attributes */ + self->priv->label_attr_list = pango_attr_list_new (); + pango_attr_list_insert (self->priv->label_attr_list, + pango_attr_weight_new (PANGO_WEIGHT_BOLD)); + + g_signal_connect (self, "notify::label", + G_CALLBACK (ggd_frame_label_notify), NULL); +} + + +GtkWidget * +ggd_frame_new (const gchar *label) +{ + return g_object_new (GGD_FRAME_TYPE, "label", label, NULL); +} Added: trunk/geanygendoc/src/ggd-widget-frame.h =================================================================== --- trunk/geanygendoc/src/ggd-widget-frame.h (rev 0) +++ trunk/geanygendoc/src/ggd-widget-frame.h 2010-05-01 17:49:41 UTC (rev 1329) @@ -0,0 +1,63 @@ +/* + * + * GeanyGenDoc, a Geany plugin to ease generation of source code documentation + * Copyright (C) 2010 Colomban Wendling <ban(a)herbesfolles.org> + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + * + */ + +#ifndef H_GGD_WIDGET_FRAME +#define H_GGD_WIDGET_FRAME + +#include <gtk/gtk.h> + +#include "ggd-macros.h" + +G_BEGIN_DECLS +GGD_BEGIN_PLUGIN_API + + +#define GGD_FRAME_TYPE (ggd_frame_get_type ()) +#define GGD_FRAME(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GGD_FRAME_TYPE, GgdFrame)) +#define GGD_FRAME_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GGD_FRAME_TYPE, GgdFrameClass)) +#define GGD_IS_FRAME(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GGD_FRAME_TYPE)) +#define GGD_IS_FRAME_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GGD_FRAME_TYPE)) + + +typedef struct _GgdFrame GgdFrame; +typedef struct _GgdFrameClass GgdFrameClass; +typedef struct _GgdFramePrivate GgdFramePrivate; + +struct _GgdFrame +{ + GtkFrame parent; + + GgdFramePrivate *priv; +}; + +struct _GgdFrameClass +{ + GtkFrameClass parent_class; +}; + + +GType ggd_frame_get_type (void); +GtkWidget *ggd_frame_new (const gchar *label); + + +GGD_END_PLUGIN_API +G_END_DECLS + +#endif /* guard */ 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:[1328] trunk/geanygendoc/TODO
by colombanw＠users.sourceforge.net 01 May '10

01 May '10

Revision: 1328 http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1328&view=rev Author: colombanw Date: 2010-05-01 17:49:07 +0000 (Sat, 01 May 2010) Log Message: ----------- GeanyGenDoc: Update TODO list Modified Paths: -------------- trunk/geanygendoc/TODO Modified: trunk/geanygendoc/TODO =================================================================== --- trunk/geanygendoc/TODO 2010-05-01 17:48:47 UTC (rev 1327) +++ trunk/geanygendoc/TODO 2010-05-01 17:49:07 UTC (rev 1328) @@ -11,3 +11,12 @@ * Support doctype-specific user-defined environment chunks. Problem: there is (for now) nothing here for this kind of settings (doctype-global but also specific to it). + +* Support per-filetype documentation type. In practice it is needed since if we + want the documentation type represent its common name (such as doxygen, + gtkdoc, javadoc, valadoc or whatever), and for example almost all users would + use valadoc for vala, but not with other languages. + In practice Doxygen seems the only (or close to be) option that would be + useful for more than one single language. + +* DOCUMENTATION! 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