[Pidgin] Doxygen modified
Pidgin
trac at pidgin.im
Tue Feb 25 02:08:26 EST 2014
Page "Doxygen" was changed by MarkDoliner
Diff URL: <https://developer.pidgin.im/wiki/Doxygen?action=diff&version=14>
Revision 14
Comment: Better API doc instructions.
Changes:
-------8<------8<------8<------8<------8<------8<------8<------8<--------
Index: Doxygen
=========================================================================
--- Doxygen (version: 13)
+++ Doxygen (version: 14)
@@ -1,6 +1,4 @@
-= Documentation generated by Doxygen =
-
-You can generate this same documentation in your source tree by running "`make docs`", then just open `./doc/html/index.html` in a web browser.
+= API documentation =
- [doxygen:2.0.0/main.html API for 2.0.0]
- [doxygen:2.2.0/main.html API for 2.2.0]
@@ -9,4 +7,17 @@
- [doxygen:2.7.11/main.html API for 2.7.11]
- [doxygen:2.10.5/main.html API for 2.10.5]
- [doxygen:dev2.x.y/main.html API for 2.x.y dev] (updated nightly from the branch im.pidgin.pidgin.2.x.y)
- - [doxygen:dev3.0.0/main.html API for 3.0.0 dev] (updated nightly from the branch im.pidgin.pidgin)
+ - [doxygen:dev3.0.0/main.html API for 3.0.0 dev] (**out of date** — no longer published here automatically)
+
+== How to build the API docs ==
+You can generate this same documentation in your source tree.
+
+=== For 2.x.y releases ===
+ 1. Run `./configure` (or `./autogen.sh` if you got your source from our Mercurial source code repository).
+ 1. Run `make docs`
+ 1. Open `./doc/html/index.html` in a web browser.
+
+=== For 3.x.y releases ===
+ 1. Run `./configure --enable-gtk-doc` (or `./autogen.sh --enable-gtk-doc` if you got your source from our Mercurial source code repository).
+ 1. Run `make`
+ 1. Open `./doc/reference/*/html/index.html` in a web browser.
-------8<------8<------8<------8<------8<------8<------8<------8<--------
--
Page URL: <https://developer.pidgin.im/wiki/Doxygen>
Pidgin <https://pidgin.im>
Pidgin
This is an automated message. Someone added your email address to be
notified of changes on 'Doxygen' page.
If it was not you, please report to datallah at pidgin.im.
More information about the Wikiedit
mailing list