Revision: 1519
http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1519&view=rev
Author: frlan
Date: 2010-08-21 09:44:20 +0000 (Sat, 21 Aug 2010)
Log Message:
-----------
Minor extension of TODO
Modified Paths:
--------------
trunk/geanylatex/TODO
Modified: trunk/geanylatex/TODO
===================================================================
--- trunk/geanylatex/TODO 2010-08-20 20:29:50 UTC (rev 1518)
+++ trunk/geanylatex/TODO 2010-08-21 09:44:20 UTC (rev 1519)
@@ -26,3 +26,4 @@
* Make special characters extensible through files
* Improve behaviour of levelup and leveldown of structures
* Adding a font size chooser to toolbar
+* Adding support for dtx
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
Revision: 1516
http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1516&view=rev
Author: sheckley
Date: 2010-08-19 16:01:16 +0000 (Thu, 19 Aug 2010)
Log Message:
-----------
small ReST fix
Modified Paths:
--------------
trunk/geany-plugins/geanyextrasel/README
Modified: trunk/geany-plugins/geanyextrasel/README
===================================================================
--- trunk/geany-plugins/geanyextrasel/README 2010-08-17 00:35:20 UTC (rev 1515)
+++ trunk/geany-plugins/geanyextrasel/README 2010-08-19 16:01:16 UTC (rev 1516)
@@ -67,18 +67,18 @@
Home Start of file
End End of file
-Unfortunately, holding Alt for rectangular selection has some problems,
-which apply both to the standard Geany keys and these added by the plugin.
-Under Windows, Alt and the keypad keys generate unicodes, even if used
-with Shift or Control. With X11, some Alt-(Ctrl)-(Shift)-movement keys
-may be used by the window manager for switching to the previous/next
-desktop, moving windows etc. So then:
+ Unfortunately, holding Alt for rectangular selection has some problems,
+ which apply both to the standard Geany keys and these added by the
+ plugin. Under Windows, the Alt-keypad keys generates unicodes, even if
+ used with Shift or Control. With X11, some Alt-(Ctrl)-(Shift)-movement
+ keys may be used by the window manager for moving windows, switching to
+ the previous/next desktop etc. So then:
4. Turn "Column mode" on. While active, the (Control)-Shift-movement keys
- will select a rectangle instead of stream without the need to hold
+ will select a rectangle instead of stream, without the need to hold
Alt (in fact, the (Control)-Alt-Shift-movement keys will be temporarily
blocked). This way, you will avoid the Alt key problems mentioned
- above, and it's move convinient to select while holding Shift only.
+ above, and it's more convenient to select while holding Shift only.
Known issues
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
Revision: 1515
http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1515&view=rev
Author: colombanw
Date: 2010-08-17 00:35:20 +0000 (Tue, 17 Aug 2010)
Log Message:
-----------
GeanyGenDoc: Don't pre-process README anymore
Pre-processing the README isn't needed anymore since the version
number was removed, and this version number was wrong anyway since
the the plugin is part of Geany-plugins.
Modified Paths:
--------------
trunk/geany-plugins/build/geanygendoc.m4
trunk/geany-plugins/geanygendoc/ChangeLog
Added Paths:
-----------
trunk/geany-plugins/geanygendoc/README
Removed Paths:
-------------
trunk/geany-plugins/geanygendoc/README.in
Modified: trunk/geany-plugins/build/geanygendoc.m4
===================================================================
--- trunk/geany-plugins/build/geanygendoc.m4 2010-08-17 00:34:54 UTC (rev 1514)
+++ trunk/geany-plugins/build/geanygendoc.m4 2010-08-17 00:35:20 UTC (rev 1515)
@@ -50,7 +50,6 @@
GP_STATUS_PLUGIN_ADD([GeanyGenDoc], [$enable_geanygendoc])
AC_CONFIG_FILES([
- geanygendoc/README
geanygendoc/Makefile
geanygendoc/src/Makefile
geanygendoc/data/Makefile
Modified: trunk/geany-plugins/geanygendoc/ChangeLog
===================================================================
--- trunk/geany-plugins/geanygendoc/ChangeLog 2010-08-17 00:34:54 UTC (rev 1514)
+++ trunk/geany-plugins/geanygendoc/ChangeLog 2010-08-17 00:35:20 UTC (rev 1515)
@@ -11,6 +11,10 @@
Add a small sentence in the introduction to guide the user in her read.
* README.in, HACKING:
Update README.in, add HACKING.
+ * ../build/geanygendoc.m4, README.in -> README:
+ Don't pre-process README anymore. It isn't needed anymore since the version
+ number was removed, and this version number was wrong anyway since the the
+ plugin is part of Geany-plugins.
2010-06-14 Colomban Wendling <ban(at)herbesfolles(dot)org>
Copied: trunk/geany-plugins/geanygendoc/README (from rev 1514, trunk/geany-plugins/geanygendoc/README.in)
===================================================================
--- trunk/geany-plugins/geanygendoc/README (rev 0)
+++ trunk/geany-plugins/geanygendoc/README 2010-08-17 00:35:20 UTC (rev 1515)
@@ -0,0 +1,93 @@
+===========
+GeanyGenDoc
+===========
+
+.. contents::
+
+
+About
+=====
+
+GeanyGenDoc is a plugin for Geany that aims to help code documentation by
+automatically generating documentation comment basis from the source code.
+
+
+Requirements
+============
+
+You will need the following packages to build GeanyGenDoc:
+
+* Geany >= 0.19 (http://www.geany.org/)
+* GTK+ >= 2.12 (http://www.gtk.org)
+* GLib >= 2.14 (http://www.gtk.org)
+* GIO >= 2.18 (http://www.gtk.org)
+* CTPL >= 0.2 (http://ctpl.tuxfamily.org/)
+* A working C compiler (GCC for example, http://gcc.gnu.org/)
+* 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
+============
+
+Compiling and installing the plugin is done by running the following
+commands from the top-level directory (it is the parent of the one
+containing this file if you're building GeanyGenDoc as part of Geany-plugins):
+
+::
+
+ $ ./configure
+ $ make
+ $ make install
+
+For more configuration details, run
+
+::
+
+ $ ./configure --help
+
+For detailed instructions, see the INSTALL file.
+
+
+Usage
+=====
+
+For more details about GeanyGenDoc, see the user manual that can be found in
+the docs/ subirectory or opened with the menu item `Tools → Documentation
+Generator → Open Manual` from the Geany window if you already runs GeanyGenDoc.
+
+
+Hacking
+=======
+
+See the HACKING file for information on how to get started on hacking
+GeanyGenDoc internals.
+
+
+License
+=======
+
+GeanyGenDoc is distributed 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. You should have received a copy
+of the GNU General Public License along with GeanyGenDoc. If not, see
+<http://www.gnu.org/licenses/>.
+
+
+Contact
+=======
+
+You can mail me at <ban(at)herbesfolles(dot)org>, and I may also be on the
+#geany channel on FreeNode, under the `b4n` nickname.
+
+
+Bug reports and feature requests
+--------------------------------
+
+To report a bug or ask for a new feature, please use the Geany-Plugins tracker
+on SourceForge: http://sourceforge.net/tracker/?group_id=222729
Deleted: trunk/geany-plugins/geanygendoc/README.in
===================================================================
--- trunk/geany-plugins/geanygendoc/README.in 2010-08-17 00:34:54 UTC (rev 1514)
+++ trunk/geany-plugins/geanygendoc/README.in 2010-08-17 00:35:20 UTC (rev 1515)
@@ -1,93 +0,0 @@
-===========
-GeanyGenDoc
-===========
-
-.. contents::
-
-
-About
-=====
-
-GeanyGenDoc is a plugin for Geany that aims to help code documentation by
-automatically generating documentation comment basis from the source code.
-
-
-Requirements
-============
-
-You will need the following packages to build GeanyGenDoc:
-
-* Geany >= 0.19 (http://www.geany.org/)
-* GTK+ >= 2.12 (http://www.gtk.org)
-* GLib >= 2.14 (http://www.gtk.org)
-* GIO >= 2.18 (http://www.gtk.org)
-* CTPL >= 0.2 (http://ctpl.tuxfamily.org/)
-* A working C compiler (GCC for example, http://gcc.gnu.org/)
-* 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
-============
-
-Compiling and installing the plugin is done by running the following
-commands from the top-level directory (it is the parent of the one
-containing this file if you're building GeanyGenDoc as part of Geany-plugins):
-
-::
-
- $ ./configure
- $ make
- $ make install
-
-For more configuration details, run
-
-::
-
- $ ./configure --help
-
-For detailed instructions, see the INSTALL file.
-
-
-Usage
-=====
-
-For more details about GeanyGenDoc, see the user manual that can be found in
-the docs/ subirectory or opened with the menu item `Tools → Documentation
-Generator → Open Manual` from the Geany window if you already runs GeanyGenDoc.
-
-
-Hacking
-=======
-
-See the HACKING file for information on how to get started on hacking
-GeanyGenDoc internals.
-
-
-License
-=======
-
-GeanyGenDoc is distributed 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. You should have received a copy
-of the GNU General Public License along with GeanyGenDoc. If not, see
-<http://www.gnu.org/licenses/>.
-
-
-Contact
-=======
-
-You can mail me at <ban(at)herbesfolles(dot)org>, and I may also be on the
-#geany channel on FreeNode, under the `b4n` nickname.
-
-
-Bug reports and feature requests
---------------------------------
-
-To report a bug or ask for a new feature, please use the Geany-Plugins tracker
-on SourceForge: http://sourceforge.net/tracker/?group_id=222729
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
Revision: 1514
http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1514&view=rev
Author: colombanw
Date: 2010-08-17 00:34:54 +0000 (Tue, 17 Aug 2010)
Log Message:
-----------
GeanyGenDoc: Update README.in, add HACKING
Modified Paths:
--------------
trunk/geany-plugins/geanygendoc/ChangeLog
trunk/geany-plugins/geanygendoc/README.in
Added Paths:
-----------
trunk/geany-plugins/geanygendoc/HACKING
Modified: trunk/geany-plugins/geanygendoc/ChangeLog
===================================================================
--- trunk/geany-plugins/geanygendoc/ChangeLog 2010-08-17 00:34:33 UTC (rev 1513)
+++ trunk/geany-plugins/geanygendoc/ChangeLog 2010-08-17 00:34:54 UTC (rev 1514)
@@ -9,6 +9,8 @@
probably the first new users would look at, then move it to the top.
* docs/manual.rst, docs/manual.html:
Add a small sentence in the introduction to guide the user in her read.
+ * README.in, HACKING:
+ Update README.in, add HACKING.
2010-06-14 Colomban Wendling <ban(at)herbesfolles(dot)org>
Added: trunk/geany-plugins/geanygendoc/HACKING
===================================================================
--- trunk/geany-plugins/geanygendoc/HACKING (rev 0)
+++ trunk/geany-plugins/geanygendoc/HACKING 2010-08-17 00:34:54 UTC (rev 1514)
@@ -0,0 +1,175 @@
+======================
+Hacking on GeanyGenDoc
+======================
+
+.. contents::
+
+
+Introduction
+============
+
+This file contains some information that may be useful to start hacking on
+GeanyGenDoc; but there might be some things that are missing. If you have a
+question for which you can't find the answer, feel free to ask a developer
+(me in fact, I'm currently the only one).
+
+
+Directory structure
+===================
+
+src/
+ Contains all the source code of GeanyGenDoc, see below for details.
+
+docs/
+ Contains the manual, this is the place to go to improve the end-user
+ documentation.
+
+data/
+ Contains the various data files of GeanyGenDoc.
+
+ filetypes/
+ Contains the file type definitions. See the end-user documentation for
+ details on the syntax of these files.
+
+
+Code organisation
+=================
+
+All source files starts with the `ggd` prefix that, obviously, stands for
+GeanyGenDoc.
+
+ggd-plugin.{c,h}
+ This is the actual plugin, the part that interacts with Geany directly:
+ it implements all the symbols that a Geany plusing must export; it takes care
+ of setting everything necessary up, and so on. Think of it as the plugin's
+ `main()`.
+
+ This is the only part of the plugin that is allowed to export symbols (see
+ below).
+
+ggd.{c,h}
+ This is the higher-level API of the plugin. It is meant to be the primary API
+ to use to build and insert documentation basis on a Geany document.
+
+ggd-doc-setting.{c,h}, ggd-doc-type.{c,h}, ggd-file-type.{c,h}
+ The main three data types of GeanyGenDoc, and their manipulation functions
+
+ggd-file-type-loader.{c,h}
+ File type loader
+
+ggd-file-type-manager.{c,h}
+ High-level loading and management of file types, also acting as a cache
+
+ggd-options.{c,h}
+ Configuration manager
+
+ggd-tag-utils.{c,h}
+ Geany's tagmanager management and utility functions. Almost all acces to tags
+ is done through this module
+
+ggd-macros.h, ggd-utils.{c,h}
+ Various utility functions and macros
+
+ggd-widget-*
+ These files are custom GTK+ widgets used by the UI part of the plugin.
+
+ ggd-widget-doctype-selector.{c,h}
+ The documentation type selector and manager widget
+
+ ggd-widget-frame.{c,h}
+ A custom frame widget
+
+
+Coding style
+============
+
+The first rule is: look at the code and follow the style.
+
+To give further consideration, the style is close to 1TBS-K&R with some
+GNU-style things. Here's an exemple, followed by notes about it:
+
+::
+
+ /**
+ * a_function:
+ * @arg1: something
+ * @n: another thing
+ *
+ * This is the documentation of the function. Write documentation for each and
+ * every non-local function. Local function can has a full documentation but
+ * in a normal comment (starting with /* and not /**), or can either have only
+ * a few line describing it or no comment at all if it is enough explicit.
+ *
+ * Returns: A number, obviously... but what does it mean?
+ */
+ int
+ a_function (const char *arg1,
+ int n)
+ {
+ int a;
+ const char *b;
+
+ a = foo ();
+ if (a == n) {
+ b = arg1;
+ } else {
+ int tmp;
+
+ b = stuff (arg1, n, A_LONG_CONSTANT, ,
+ ANOTHER_LONG_CONSTANT_THAT_GOES_BEYOND_80TH_COLUMN);
+ if (got_it (&tmp)) {
+ a = tmp;
+ } else {
+ a = n;
+ }
+ }
+ if (! variable || (A_THIRD_WAY_TOO_LONG_CONSTANT && ITS_ME_AGAIN &&
+ PLEASE_STOP_THIS)) {
+ /* you may want to explain why you do this operation, so put a comment
+ * just before it. it is also good to document magic numbers such as this
+ * "8" that comes from nowhere. */
+ a = n << 8;
+ }
+
+ return a;
+ }
+
+You can see that (in random order):
+
+* The indentation consists of 2 spaces per level -- no tabs;
+* The return type is on its own line (as in GNU style);
+* There is a space between function name and argumen list;
+* Variables and arguments declarations are aligned, one per line.
+* If the arguments of a function call, a macro, an expression, etc., would
+ overflow the 80th column rule, it is split on two (or more, as needed) lines,
+ aligned on the corresponding parenthesis;
+* There is blank lines at two places: right after some variable declarations,
+ and right before the return statement;
+* There is no parenthesis around the return statement;
+* Put a space between the unary operator `!` and its operand;
+* There is a space around binary operators;
+* Use const everywhere it makes sense, almost like a sementic annotation;
+* There is braces around every block (1TBS style);
+* Constants are uppercase;
+* So are macros that may have side effects;
+* Decalre local variables at the scope they belongs;
+* Document non-local functions with a Gtk-Doc documentation comment -- you know
+ what? GeanyGenDoc can help!
+* You don't see it in this example, but give pointful names to functions,
+ variables, marcos, etc.
+
+
+API, ABI, exported symbols, stuff like that
+-------------------------------------------
+
+Always use static functions if they should have file scope; and prefix all
+non-local symbol with the `ggd` prefix (with the appropriate case).
+
+Besides this, don't pollute the list of exported symbols of the plugin. Even if
+all symbols that might be exported by accident are prefixed, exporting them has
+no point (this isn't a library) and only bloates the output ELF (or whatever)
+binary.
+
+To prevent this, all "public" (read: that is used outside its file/module)
+should have a protorype that is protected with `GGD_BEGIN_PLUGIN_API`
+and `GGD_END_PLUGIN_API` (see gdd-macros.h for details).
Modified: trunk/geany-plugins/geanygendoc/README.in
===================================================================
--- trunk/geany-plugins/geanygendoc/README.in 2010-08-17 00:34:33 UTC (rev 1513)
+++ trunk/geany-plugins/geanygendoc/README.in 2010-08-17 00:34:54 UTC (rev 1514)
@@ -1,37 +1,93 @@
-General Information
-===================
+===========
+GeanyGenDoc
+===========
-This is GeanyGenDoc @VERSION@, a plugin for Geany that aims to automatically
-generate documentation comment basis from the source code.
+.. contents::
+
+About
+=====
+
+GeanyGenDoc is a plugin for Geany that aims to help code documentation by
+automatically generating documentation comment basis from the source code.
+
+
Requirements
============
You will need the following packages to build GeanyGenDoc:
- - Geany >= 0.19 (http://www.geany.org/)
- - GTK+ >= 2.12 (http://www.gtk.org)
- - GLib >= 2.14 (http://www.gtk.org)
- - GIO >= 2.18 (http://www.gtk.org)
- - CTPL >= 0.2 (http://ctpl.tuxfamily.org/)
- - A working C compiler (GCC for example, http://gcc.gnu.org/)
- - A working make implementation (GNU make is recommended,
- http://www.gnu.org/software/make/)
+* Geany >= 0.19 (http://www.geany.org/)
+* GTK+ >= 2.12 (http://www.gtk.org)
+* GLib >= 2.14 (http://www.gtk.org)
+* GIO >= 2.18 (http://www.gtk.org)
+* CTPL >= 0.2 (http://ctpl.tuxfamily.org/)
+* A working C compiler (GCC for example, http://gcc.gnu.org/)
+* 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.
+* Docutils (http://docutils.sourceforge.net/) -- or another implementation of
+ rst2html -- is needed to (re)generate the HTML manual.
+
Installation
============
-Compiling and installing the plugin is done by the following commands:
+Compiling and installing the plugin is done by running the following
+commands from the top-level directory (it is the parent of the one
+containing this file if you're building GeanyGenDoc as part of Geany-plugins):
+::
+
$ ./configure
$ make
$ make install
-For more configuration details run
+For more configuration details, run
+
+::
+
$ ./configure --help
For detailed instructions, see the INSTALL file.
+
+
+Usage
+=====
+
+For more details about GeanyGenDoc, see the user manual that can be found in
+the docs/ subirectory or opened with the menu item `Tools → Documentation
+Generator → Open Manual` from the Geany window if you already runs GeanyGenDoc.
+
+
+Hacking
+=======
+
+See the HACKING file for information on how to get started on hacking
+GeanyGenDoc internals.
+
+
+License
+=======
+
+GeanyGenDoc is distributed 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. You should have received a copy
+of the GNU General Public License along with GeanyGenDoc. If not, see
+<http://www.gnu.org/licenses/>.
+
+
+Contact
+=======
+
+You can mail me at <ban(at)herbesfolles(dot)org>, and I may also be on the
+#geany channel on FreeNode, under the `b4n` nickname.
+
+
+Bug reports and feature requests
+--------------------------------
+
+To report a bug or ask for a new feature, please use the Geany-Plugins tracker
+on SourceForge: http://sourceforge.net/tracker/?group_id=222729
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
Revision: 1513
http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1513&view=rev
Author: colombanw
Date: 2010-08-17 00:34:33 +0000 (Tue, 17 Aug 2010)
Log Message:
-----------
GeanyGenDoc: Improve a bit manual's introduction
Add a small sentence in the introduction to guide the user in her
read.
Modified Paths:
--------------
trunk/geany-plugins/geanygendoc/ChangeLog
trunk/geany-plugins/geanygendoc/docs/manual.html
trunk/geany-plugins/geanygendoc/docs/manual.rst
Modified: trunk/geany-plugins/geanygendoc/ChangeLog
===================================================================
--- trunk/geany-plugins/geanygendoc/ChangeLog 2010-08-17 00:34:11 UTC (rev 1512)
+++ trunk/geany-plugins/geanygendoc/ChangeLog 2010-08-17 00:34:33 UTC (rev 1513)
@@ -7,6 +7,8 @@
* docs/manual.rst, docs/manual.html:
Move "User interface in Geany" part on the top of the manual. This part is
probably the first new users would look at, then move it to the top.
+ * docs/manual.rst, docs/manual.html:
+ Add a small sentence in the introduction to guide the user in her read.
2010-06-14 Colomban Wendling <ban(at)herbesfolles(dot)org>
Modified: trunk/geany-plugins/geanygendoc/docs/manual.html
===================================================================
--- trunk/geany-plugins/geanygendoc/docs/manual.html 2010-08-17 00:34:11 UTC (rev 1512)
+++ trunk/geany-plugins/geanygendoc/docs/manual.html 2010-08-17 00:34:33 UTC (rev 1513)
@@ -95,6 +95,9 @@
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>
+<p>If you are impatient, you will probably want to discover the <a class="reference internal" href="#user-interface-in-geany">user interface in
+Geany</a> first; but if you have the time to discover the tool, take a look at the
+<a class="reference internal" href="#design">design</a> and learn how GeanyGenDoc works and how you can take the most of it.</p>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
Modified: trunk/geany-plugins/geanygendoc/docs/manual.rst
===================================================================
--- trunk/geany-plugins/geanygendoc/docs/manual.rst 2010-08-17 00:34:11 UTC (rev 1512)
+++ trunk/geany-plugins/geanygendoc/docs/manual.rst 2010-08-17 00:34:33 UTC (rev 1513)
@@ -14,7 +14,11 @@
Basically, it generates and inserts text chunks, particularly from document's
symbols. Its goal is to ease writing documentation for the good.
+If you are impatient, you will probably want to discover the `user interface in
+Geany`_ first; but if you have the time to discover the tool, take a look at the
+`design`_ and learn how GeanyGenDoc works and how you can take the most of it.
+
.. contents::
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
Revision: 1512
http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1512&view=rev
Author: colombanw
Date: 2010-08-17 00:34:11 +0000 (Tue, 17 Aug 2010)
Log Message:
-----------
GeanyGenDoc: Move "User interface in Geany" part on the top of the manual
This part is probably the first new users would look at, then move
it to the top.
Modified Paths:
--------------
trunk/geany-plugins/geanygendoc/ChangeLog
trunk/geany-plugins/geanygendoc/docs/manual.html
trunk/geany-plugins/geanygendoc/docs/manual.rst
Modified: trunk/geany-plugins/geanygendoc/ChangeLog
===================================================================
--- trunk/geany-plugins/geanygendoc/ChangeLog 2010-08-17 00:33:50 UTC (rev 1511)
+++ trunk/geany-plugins/geanygendoc/ChangeLog 2010-08-17 00:34:11 UTC (rev 1512)
@@ -4,6 +4,9 @@
Add license information in the manual.
* docs/manual.css:
Add a style definition for blockquotes in the manual stylesheet.
+ * docs/manual.rst, docs/manual.html:
+ Move "User interface in Geany" part on the top of the manual. This part is
+ probably the first new users would look at, then move it to the top.
2010-06-14 Colomban Wendling <ban(at)herbesfolles(dot)org>
Modified: trunk/geany-plugins/geanygendoc/docs/manual.html
===================================================================
--- trunk/geany-plugins/geanygendoc/docs/manual.html 2010-08-17 00:33:50 UTC (rev 1511)
+++ trunk/geany-plugins/geanygendoc/docs/manual.html 2010-08-17 00:34:11 UTC (rev 1512)
@@ -99,38 +99,38 @@
<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>
+<li><a class="reference internal" href="#user-interface-in-geany" id="id5">User interface in Geany</a><ul>
+<li><a class="reference internal" href="#menus" id="id6">Menus</a><ul>
+<li><a class="reference internal" href="#editor-s-pop-up-menu" id="id7">Editor's pop-up menu</a></li>
+<li><a class="reference internal" href="#tools-menu" id="id8">Tools menu</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>
+<li><a class="reference internal" href="#preferences-dialog" id="id9">Preferences dialog</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>
+<li><a class="reference internal" href="#design" id="id10">Design</a></li>
+<li><a class="reference internal" href="#syntax" id="id11">Syntax</a><ul>
+<li><a class="reference internal" href="#key-value-pairs" id="id12">Key-Value pairs</a></li>
+<li><a class="reference internal" href="#naming" id="id13">Naming</a></li>
+<li><a class="reference internal" href="#comments" id="id14">Comments</a></li>
+<li><a class="reference internal" href="#value-types" id="id15">Value types</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>
+<li><a class="reference internal" href="#file-types" id="id16">File types</a><ul>
+<li><a class="reference internal" href="#the-settings-group" id="id17">The <tt class="docutils literal">settings</tt> group</a></li>
+<li><a class="reference internal" href="#the-doctypes-group" id="id18">The <tt class="docutils literal">doctypes</tt> group</a></li>
</ul>
</li>
-<li><a class="reference internal" href="#rule-settings" id="id19">Rule settings</a></li>
+<li><a class="reference internal" href="#documentation-types" id="id19">Documentation types</a><ul>
+<li><a class="reference internal" href="#short-example" id="id20">Short example</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>
+<li><a class="reference internal" href="#rules-the-cool-thing" id="id21">Rules: the cool thing</a><ul>
+<li><a class="reference internal" href="#type-hierarchy" id="id22">Type hierarchy</a><ul>
+<li><a class="reference internal" href="#known-types" id="id23">Known types</a></li>
</ul>
</li>
-<li><a class="reference internal" href="#preferences-dialog" id="id24">Preferences dialog</a></li>
+<li><a class="reference internal" href="#rule-settings" id="id24">Rule settings</a></li>
</ul>
</li>
<li><a class="reference internal" href="#miscellaneous" id="id25">Miscellaneous</a><ul>
@@ -145,8 +145,82 @@
</ul>
</div>
</div>
+<div class="section" id="user-interface-in-geany">
+<h1><a class="toc-backref" href="#id5">User interface in Geany</a></h1>
+<div class="section" id="menus">
+<h2><a class="toc-backref" href="#id6">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="#id7">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="#id8">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="#id9">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="design">
-<h1><a class="toc-backref" href="#id5">Design</a></h1>
+<h1><a class="toc-backref" href="#id10">Design</a></h1>
<p>GeanyGenDoc has an extensible design based on three points: file type,
documentation type and rules.</p>
<dl class="docutils">
@@ -168,9 +242,9 @@
</dl>
</div>
<div class="section" id="syntax">
-<h1><a class="toc-backref" href="#id6">Syntax</a></h1>
+<h1><a class="toc-backref" href="#id11">Syntax</a></h1>
<div class="section" id="key-value-pairs">
-<h2><a class="toc-backref" href="#id7">Key-Value pairs</a></h2>
+<h2><a class="toc-backref" href="#id12">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>
@@ -201,12 +275,12 @@
</pre>
</div>
<div class="section" id="naming">
-<h2><a class="toc-backref" href="#id8">Naming</a></h2>
+<h2><a class="toc-backref" href="#id13">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>
+<h2><a class="toc-backref" href="#id14">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>
@@ -218,7 +292,7 @@
</pre>
</div>
<div class="section" id="value-types">
-<h2><a class="toc-backref" href="#id10">Value types</a></h2>
+<h2><a class="toc-backref" href="#id15">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
@@ -264,7 +338,7 @@
</div>
</div>
<div class="section" id="file-types">
-<h1><a class="toc-backref" href="#id11">File types</a></h1>
+<h1><a class="toc-backref" href="#id16">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>
@@ -274,7 +348,7 @@
<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>
+<h2><a class="toc-backref" href="#id17">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>
@@ -288,12 +362,12 @@
</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>
+<h2><a class="toc-backref" href="#id18">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>
+<h1><a class="toc-backref" href="#id19">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>
@@ -303,7 +377,7 @@
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>
+<h2><a class="toc-backref" href="#id20">Short example</a></h2>
<pre class="literal-block">
doxygen = {
struct.member = {
@@ -316,14 +390,14 @@
</div>
</div>
<div class="section" id="rules-the-cool-thing">
-<h1><a class="toc-backref" href="#id16">Rules: the cool thing</a></h1>
+<h1><a class="toc-backref" href="#id21">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>
+<h2><a class="toc-backref" href="#id22">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,
@@ -339,7 +413,7 @@
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>
+<h3><a class="toc-backref" href="#id23">Known types</a></h3>
<dl class="docutils">
<dt><tt class="docutils literal">class</tt></dt>
<dd>A class.</dd>
@@ -383,7 +457,7 @@
</div>
</div>
<div class="section" id="rule-settings">
-<h2><a class="toc-backref" href="#id19">Rule settings</a></h2>
+<h2><a class="toc-backref" href="#id24">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
@@ -450,80 +524,6 @@
</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">
Modified: trunk/geany-plugins/geanygendoc/docs/manual.rst
===================================================================
--- trunk/geany-plugins/geanygendoc/docs/manual.rst 2010-08-17 00:33:50 UTC (rev 1511)
+++ trunk/geany-plugins/geanygendoc/docs/manual.rst 2010-08-17 00:34:11 UTC (rev 1512)
@@ -18,6 +18,88 @@
.. contents::
+User interface in Geany
+=======================
+
+Menus
+-----
+
+GeanyGenDoc adds an item named `Insert Documentation Comment` in the editor's
+pop-up under the `Insert Comments` sub-menu; and a menu named
+`Documentation Generator` into the `Tools` menu.
+
+Editor's pop-up menu
+~~~~~~~~~~~~~~~~~~~~
+
+The item `Editor's pop-up → Insert Comments → Insert Documentation Comment`
+generates documentation for the current symbol. It has a keyboard shortcut
+that can be configured through Geany's keybinding configuration system, under
+`GeanyGenDoc → Insert Documentation Comment`.
+
+Tools menu
+~~~~~~~~~~
+
+The `Documentation Generator` menu under `Tools` contains the following items:
+
+`Document Current Symbol`
+ This generates documentation for the current symbol. It is equivalent to the
+ item `Insert Documentation Comment` that can be found in the editor's pop-up
+ menu.
+
+`Document All Symbols`
+ This generates documentation for all symbols in the document. This is
+ equivalent to manually requesting documentation generation for each symbol in
+ the document.
+
+`Reload Configuration Files`
+ This force reloading of all the `file type`_ 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.
+
+`Edit Current Language Configuration`
+ 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 `configuration
+ directory`_ transparently.
+
+`Open Manual`
+ Opens this manual in a browser.
+
+
+Preferences dialog
+------------------
+
+The preferences dialog, than can either be opened through `Edit →
+Plugin Preferences` or with the `Preferences` button in the plugin manager,
+allows to modify the following preferences:
+
+`General`
+ `Save file before generating documentation`
+ 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.
+
+ `Indent inserted documentation`
+ Chooses whether the inserted documentation should be indented to fit the
+ indentation at the insertion position.
+
+`Documentation type`
+ This list allows you to choose the documentation type to use with each file
+ type. The special language `All` on top of the list is used to choose the
+ default documentation type, used for all languages that haven't one set.
+
+`Global environment`
+ Global environment overrides and additions. This is an environment that will
+ be merged with the `file type`_-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 `Since` tag, define the `Doxygen`_ 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.
+
+
Design
======
@@ -360,88 +442,6 @@
Whether to also document symbol's children (according to their own rules).
-User interface in Geany
-=======================
-
-Menus
------
-
-GeanyGenDoc adds an item named `Insert Documentation Comment` in the editor's
-pop-up under the `Insert Comments` sub-menu; and a menu named
-`Documentation Generator` into the `Tools` menu.
-
-Editor's pop-up menu
-~~~~~~~~~~~~~~~~~~~~
-
-The item `Editor's pop-up → Insert Comments → Insert Documentation Comment`
-generates documentation for the current symbol. It has a keyboard shortcut
-that can be configured through Geany's keybinding configuration system, under
-`GeanyGenDoc → Insert Documentation Comment`.
-
-Tools menu
-~~~~~~~~~~
-
-The `Documentation Generator` menu under `Tools` contains the following items:
-
-`Document Current Symbol`
- This generates documentation for the current symbol. It is equivalent to the
- item `Insert Documentation Comment` that can be found in the editor's pop-up
- menu.
-
-`Document All Symbols`
- This generates documentation for all symbols in the document. This is
- equivalent to manually requesting documentation generation for each symbol in
- the document.
-
-`Reload Configuration Files`
- This force reloading of all the `file type`_ 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.
-
-`Edit Current Language Configuration`
- 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 `configuration
- directory`_ transparently.
-
-`Open Manual`
- Opens this manual in a browser.
-
-
-Preferences dialog
-------------------
-
-The preferences dialog, than can either be opened through `Edit →
-Plugin Preferences` or with the `Preferences` button in the plugin manager,
-allows to modify the following preferences:
-
-`General`
- `Save file before generating documentation`
- 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.
-
- `Indent inserted documentation`
- Chooses whether the inserted documentation should be indented to fit the
- indentation at the insertion position.
-
-`Documentation type`
- This list allows you to choose the documentation type to use with each file
- type. The special language `All` on top of the list is used to choose the
- default documentation type, used for all languages that haven't one set.
-
-`Global environment`
- Global environment overrides and additions. This is an environment that will
- be merged with the `file type`_-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 `Since` tag, define the `Doxygen`_ 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.
-
-
Miscellaneous
=============
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
Revision: 1510
http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1510&view=rev
Author: colombanw
Date: 2010-08-17 00:33:29 +0000 (Tue, 17 Aug 2010)
Log Message:
-----------
GeanyGenDoc: Add license information in the manual
Modified Paths:
--------------
trunk/geany-plugins/geanygendoc/ChangeLog
trunk/geany-plugins/geanygendoc/docs/manual.html
trunk/geany-plugins/geanygendoc/docs/manual.rst
Modified: trunk/geany-plugins/geanygendoc/ChangeLog
===================================================================
--- trunk/geany-plugins/geanygendoc/ChangeLog 2010-08-16 15:46:01 UTC (rev 1509)
+++ trunk/geany-plugins/geanygendoc/ChangeLog 2010-08-17 00:33:29 UTC (rev 1510)
@@ -1,3 +1,9 @@
+2010-08-17 Colomban Wendling <ban(at)herbesfolles(dot)org>
+
+ * docs/manual.rst, docs/manual.html:
+ Add license information in the manual.
+
+
2010-06-14 Colomban Wendling <ban(at)herbesfolles(dot)org>
* src/ggd-plugin.h:
Modified: trunk/geany-plugins/geanygendoc/docs/manual.html
===================================================================
--- trunk/geany-plugins/geanygendoc/docs/manual.html 2010-08-16 15:46:01 UTC (rev 1509)
+++ trunk/geany-plugins/geanygendoc/docs/manual.html 2010-08-17 00:33:29 UTC (rev 1510)
@@ -3,7 +3,7 @@
<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/" />
+<meta name="generator" content="Docutils 0.7: http://docutils.sourceforge.net/" />
<title>GeanyGenDoc User Manual</title>
<style type="text/css">
@@ -38,6 +38,12 @@
text-align: justify;
}
+blockquote {
+ padding-left: 1em;
+ margin-left: 1em;
+ border-left: 3px solid #5c3566;
+}
+
.literal-block,
.literal {
background: #fff;
@@ -132,7 +138,8 @@
</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>
+<li><a class="reference internal" href="#license" id="id28">License</a></li>
+<li><a class="reference internal" href="#configuration-syntax-summary" id="id29">Configuration syntax summary</a></li>
</ul>
</li>
</ul>
@@ -540,8 +547,25 @@
</div>
<div class="section" id="appendix">
<h1><a class="toc-backref" href="#id27">Appendix</a></h1>
+<div class="section" id="license">
+<h2><a class="toc-backref" href="#id28">License</a></h2>
+<div class="line-block">
+<div class="line">GeanyGenDoc, a Geany plugin to ease generation of source code documentation</div>
+<div class="line">Copyright (C) 2010 Colomban Wendling <<a class="reference external" href="mailto:ban@herbesfolles.org">ban@herbesfolles.org</a>></div>
+</div>
+<p>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.</p>
+<p>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.</p>
+<p>You should have received a copy of the GNU General Public License
+along with this program. If not, see <<a class="reference external" href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>>.</p>
+</div>
<div class="section" id="configuration-syntax-summary">
-<h2><a class="toc-backref" href="#id28">Configuration syntax summary</a></h2>
+<h2><a class="toc-backref" href="#id29">Configuration syntax summary</a></h2>
<pre class="literal-block">
string ::= ( """ .* """ | "'" .* "'" )
constant ::= [_A-Z][_A-Z0-9]+
@@ -595,7 +619,7 @@
</div>
<div class="footer">
<hr class="footer" />
-Generated on: 2010-05-22.
+Generated on: 2010-08-16.
</div>
</body>
Modified: trunk/geany-plugins/geanygendoc/docs/manual.rst
===================================================================
--- trunk/geany-plugins/geanygendoc/docs/manual.rst 2010-08-16 15:46:01 UTC (rev 1509)
+++ trunk/geany-plugins/geanygendoc/docs/manual.rst 2010-08-17 00:33:29 UTC (rev 1510)
@@ -470,6 +470,26 @@
Appendix
========
+License
+-------
+
+| GeanyGenDoc, a Geany plugin to ease generation of source code documentation
+| Copyright (C) 2010 Colomban Wendling <ban(at)herbesfolles(dot)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/>.
+
+
Configuration syntax summary
----------------------------
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.