| 1 |
GeanyGenDoc |
| 2 |
=========== |
| 3 |
|
| 4 |
.. contents:: |
| 5 |
|
| 6 |
|
| 7 |
About |
| 8 |
===== |
| 9 |
|
| 10 |
GeanyGenDoc is a plugin for Geany that aims to help code documentation by |
| 11 |
automatically generating documentation comment basis from the source code. |
| 12 |
|
| 13 |
|
| 14 |
Requirements |
| 15 |
============ |
| 16 |
|
| 17 |
You will need the following packages to build GeanyGenDoc: |
| 18 |
|
| 19 |
* Geany >= 0.19 (http://www.geany.org/) |
| 20 |
* GTK+ >= 2.12 (http://www.gtk.org) |
| 21 |
* GLib >= 2.14 (http://www.gtk.org) |
| 22 |
* GIO >= 2.18 (http://www.gtk.org) |
| 23 |
* CTPL >= 0.3 (http://ctpl.tuxfamily.org/) |
| 24 |
* A working C compiler (GCC for example, http://gcc.gnu.org/) |
| 25 |
* A working make implementation (GNU make is recommended, |
| 26 |
http://www.gnu.org/software/make/) |
| 27 |
|
| 28 |
You may also want the following package that enables extra features: |
| 29 |
|
| 30 |
* Docutils (http://docutils.sourceforge.net/) -- or another implementation of |
| 31 |
rst2html -- is needed to (re)generate the HTML manual. |
| 32 |
|
| 33 |
|
| 34 |
Usage |
| 35 |
===== |
| 36 |
|
| 37 |
For more details about GeanyGenDoc, see the user manual that can be found in |
| 38 |
the docs/ subdirectory or opened with the menu item `Tools → Documentation |
| 39 |
Generator → Open Manual` from the Geany window if you already run GeanyGenDoc. |
| 40 |
|
| 41 |
|
| 42 |
Hacking |
| 43 |
======= |
| 44 |
|
| 45 |
See the HACKING file for information on how to get started on hacking |
| 46 |
GeanyGenDoc internals. |
| 47 |
|
| 48 |
|
| 49 |
License |
| 50 |
======= |
| 51 |
|
| 52 |
GeanyGenDoc is distributed under the terms of the GNU General Public License |
| 53 |
as published by the Free Software Foundation, either version 3 of the |
| 54 |
License, or (at your option) any later version. You should have received a copy |
| 55 |
of the GNU General Public License along with GeanyGenDoc. If not, see |
| 56 |
<http://www.gnu.org/licenses/>. |
| 57 |
|
| 58 |
|
| 59 |
Contact |
| 60 |
======= |
| 61 |
|
| 62 |
You can mail me at <ban(at)herbesfolles(dot)org>, and I may also be on the |
| 63 |
#geany channel on FreeNode, under the `b4n` nickname. |
| 64 |
|
| 65 |
|
| 66 |
Bug reports and feature requests |
| 67 |
-------------------------------- |
| 68 |
|
| 69 |
To report a bug or ask for a new feature, please use the Geany-Plugins tracker |
| 70 |
on GitHub: https://github.com/geany/geany-plugins/issues |