gw0kin / gnome2-globalmenu

Automatically exported from code.google.com/p/gnome2-globalmenu
GNU General Public License v2.0
0 stars 0 forks source link

Simplify Documentation #179

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago
Currently it is a real mess to get info.
I'm making a faq (see other issue reported), but we have to reorganize the
documentation and consolidate external tutorials:
-Ayoli's tutorials on his blog. Are they still valid ? Merge them with
existing ones
-Merge the Quick Install on Ubuntu and the Install on Ubuntu
-Be sure to provide install methods for the old versions (still wanted
because more features) and the newest ones
-include some TOCs and make the wikipages appealing.

-promote the FAQ to frontpage.

Original issue reported on code.google.com by pierre.s...@gmail.com on 23 Nov 2008 at 7:57

GoogleCodeExporter commented 9 years ago
I recommend to use Doxygen (http://www.stack.nl/~dimitri/doxygen/index.html) to
comment and document all of the source code. It will also provide/create an API
documentation (Issue: #139) as well.

It will look like this:
http://developer.pidgin.im/doxygen/2.5.2/html/group__core.html

Original comment by bmarw...@gmail.com on 3 Feb 2009 at 5:27

GoogleCodeExporter commented 9 years ago
For vala there is valadoc.
Doxygen doesn't work for vala as far as I know.

Original comment by rainwood...@gmail.com on 3 Feb 2009 at 8:01

GoogleCodeExporter commented 9 years ago
Here's the rewritten Ubuntu Install Guide using the PPA:
http://code.google.com/p/gnome2-globalmenu/wiki/InstallingonUbuntu
Should we remove the deprecated tag?

Original comment by pierre.s...@gmail.com on 14 Feb 2009 at 3:18

GoogleCodeExporter commented 9 years ago
Indeed. Removed.

Original comment by rainwood...@gmail.com on 14 Feb 2009 at 4:28