[gtksourceviewmm] Update main page in documentation.
- From: Krzesimir Nowak <krnowak src gnome org>
- To: svn-commits-list gnome org
- Cc:
- Subject: [gtksourceviewmm] Update main page in documentation.
- Date: Wed, 13 Jan 2010 22:58:45 +0000 (UTC)
commit 8d092d90482f43342b226a773a07c5edeae6d582
Author: Krzesimir Nowak <qdlacz gmail com>
Date: Wed Jan 13 23:54:28 2010 +0100
Update main page in documentation.
* docs/reference/reference-index.txt: Deleted - its content is
moved to main include header.
* gtksourceview/gtksourceviewmm.h: Placed here an updated main
page.
* docs/Makefile.am: Update include files to include
gtksourceviewmm.h instead of reference-index.txt.
* docs/reference/Doxyfile.in: Some option changes - taken from
current mm-common.
docs/Makefile.am | 2 +-
docs/reference/Doxyfile.in | 25 +++++++++---------
docs/reference/reference-index.txt | 49 ------------------------------------
gtksourceview/gtksourceviewmm.h | 49 ++++++++++++++++++++++++++++++++++++
4 files changed, 62 insertions(+), 63 deletions(-)
---
diff --git a/docs/Makefile.am b/docs/Makefile.am
index 19046be..50f724a 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -4,6 +4,6 @@ include $(top_srcdir)/gtksourceview/gtksourceviewmm/filelist.am
gtksourceviewmm_files_h = $(files_built_h) $(filter-out wrap_init.h,$(files_extra_h))
book_name = $(GTKSOURCEVIEWMM_MODULE_NAME)
-doc_input = $(addprefix $(top_srcdir)/gtksourceview/gtksourceviewmm/,$(gtksourceviewmm_files_h)) $(srcdir)/reference/reference-index.txt
+doc_input = $(addprefix $(top_srcdir)/gtksourceview/gtksourceviewmm/,$(gtksourceviewmm_files_h)) $(top_srcdir)/gtksourceview/gtksourceviewmm.h
include $(top_srcdir)/build/doc-reference.am
diff --git a/docs/reference/Doxyfile.in b/docs/reference/Doxyfile.in
index 82d38f7..d53b814 100644
--- a/docs/reference/Doxyfile.in
+++ b/docs/reference/Doxyfile.in
@@ -48,20 +48,20 @@ SYMBOL_CACHE_SIZE = 0
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
-EXTRACT_ALL = YES
-EXTRACT_PRIVATE = NO
+EXTRACT_ALL = NO
+EXTRACT_PRIVATE = YES
EXTRACT_STATIC = NO
EXTRACT_LOCAL_CLASSES = NO
EXTRACT_LOCAL_METHODS = NO
EXTRACT_ANON_NSPACES = NO
-HIDE_UNDOC_MEMBERS = NO
+HIDE_UNDOC_MEMBERS = YES
HIDE_UNDOC_CLASSES = YES
HIDE_FRIEND_COMPOUNDS = YES
HIDE_IN_BODY_DOCS = YES
INTERNAL_DOCS = NO
CASE_SENSE_NAMES = YES
HIDE_SCOPE_NAMES = NO
-SHOW_INCLUDE_FILES = NO
+SHOW_INCLUDE_FILES = YES
INLINE_INFO = YES
SORT_MEMBER_DOCS = YES
SORT_BRIEF_DOCS = NO
@@ -74,7 +74,7 @@ GENERATE_BUGLIST = NO
GENERATE_DEPRECATEDLIST= YES
ENABLED_SECTIONS =
MAX_INITIALIZER_LINES = 2
-SHOW_USED_FILES = YES
+SHOW_USED_FILES = NO
SHOW_DIRECTORIES = NO
SHOW_FILES = NO
SHOW_NAMESPACES = YES
@@ -87,7 +87,7 @@ QUIET = NO
WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES
WARN_IF_DOC_ERROR = YES
-WARN_NO_PARAMDOC = NO
+WARN_NO_PARAMDOC = YES
WARN_FORMAT = "$file:$line: $text"
WARN_LOGFILE = reference/doxygen.log
#---------------------------------------------------------------------------
@@ -130,7 +130,7 @@ VERBATIM_HEADERS = NO
#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
-ALPHABETICAL_INDEX = YES
+ALPHABETICAL_INDEX = NO
COLS_IN_ALPHA_INDEX = 5
IGNORE_PREFIX =
#---------------------------------------------------------------------------
@@ -141,7 +141,6 @@ HTML_OUTPUT = html
HTML_FILE_EXTENSION = .html
HTML_HEADER =
HTML_FOOTER =
-HTML_TIMESTAMP = NO
HTML_STYLESHEET = "@MMDOCTOOLDIR@/doxygen.css"
HTML_ALIGN_MEMBERS = YES
HTML_DYNAMIC_SECTIONS = NO
@@ -262,18 +261,18 @@ PERL_PATH = @PERL@
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
-CLASS_DIAGRAMS = NO
+CLASS_DIAGRAMS = YES
MSCGEN_PATH =
HIDE_UNDOC_RELATIONS = NO
HAVE_DOT = YES
-DOT_FONTNAME = FreeSans
+DOT_FONTNAME = Sans
DOT_FONTSIZE = 10
DOT_FONTPATH =
CLASS_GRAPH = YES
-COLLABORATION_GRAPH = YES
-GROUP_GRAPHS = YES
+COLLABORATION_GRAPH = NO
+GROUP_GRAPHS = NO
UML_LOOK = NO
-TEMPLATE_RELATIONS = YES
+TEMPLATE_RELATIONS = NO
INCLUDE_GRAPH = NO
INCLUDED_BY_GRAPH = NO
CALL_GRAPH = NO
diff --git a/gtksourceview/gtksourceviewmm.h b/gtksourceview/gtksourceviewmm.h
index 7b48c76..2c1af5a 100644
--- a/gtksourceview/gtksourceviewmm.h
+++ b/gtksourceview/gtksourceviewmm.h
@@ -23,6 +23,55 @@
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
+/** @mainpage gtksourceviewmm - A C++ binding for gtksourceview
+ *
+ * @section introduction Introduction
+ * gtksourceviewmm is a C++ wrapper for the gtksourceview widget library.
+ * It offers all the power of gtksourceview with an interface familiar to C++
+ * developers, including users of the gtkmm library.
+ *
+ * @section status Status
+ * gtksourceviewmm wraps all relevant parts of the gtksourceview library and has
+ * proven to be useable so far.
+ *
+ * @section sourcecode Source code
+ *
+ * Source code is developed on GNOME git and release tarballs are stored on
+ * GNOME FTP site.
+ *
+ * @subsection browsecode Browse the source code
+ *
+ * See: <tt>http://git.gnome.org/browse/gtksourceviewmm/</tt>.
+ *
+ * @subsection bleedingedge Getting bleeding edge code from git
+ *
+ * <tt>git clone git://git.gnome.org/gtksourceviewmm gtksourceviewmm</tt>
+ *
+ * @subsection download Download releases tarballs
+ *
+ * See <tt>http://download.gnome.org/sources/gtksourceviewmm/</tt>.
+ *
+ * @section license License
+ * gtksourceviewmm is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ * See the text of the LGPL for more details:
+ * http://www.gnu.org/licenses/lgpl.html .
+ *
+ * @section Contact
+ * To contact the developers of gtksourceviewmm please send an email to
+ * the gtkmm mailing list at gtkmm-list gnome org See
+ * <tt>http://www.gtkmm.org/mailinglist.shtml</tt>. Or join @c c++ channel at
+ * <tt>irc.gnome.org</tt>. See <tt>http://live.gnome.org/GnomeIrcChannels</tt>.
+ *
+ * @section about About
+ * Initial work has been done by Rob Page.
+ * Dodji Seketeli, Murray Cumming, Daniel Elstner, Jonathon Jongsma and
+ * Krzesimir Nowak with contributions from other people wrote most of the code
+ * of this project.
+ */
+
#include <gtksourceviewmm/init.h>
#include <gtksourceviewmm/sourcebuffer.h>
#include <gtksourceviewmm/sourcecompletionactivation.h>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]