[prev in list] [next in list] [prev in thread] [next in thread]
List: kde-core-devel
Subject: [patch] more human-readable titles for API docs
From: Jarosław_Staniek <js () iidea ! pl>
Date: 2007-06-12 22:27:08
Message-ID: 200706130027.08643.js () iidea ! pl
[Download RAW message or body]
RFC, this makes appearance of http://api.kde.org/4.0-api a bit more
professional, at least for non-core devs.
--
regards / pozdrawiam, Jaroslaw Staniek
Sponsored by OpenOffice Polska (http://www.openoffice.com.pl/en) to work on
Kexi & KOffice: http://www.kexi-project.org, http://www.koffice.org
KDE3 & KDE4 Libraries for MS Windows: http://kdelibs.com, http://www.kde.org
["Mainpage.patch" (text/x-diff)]
Index: threadweaver/Mainpage.dox
===================================================================
--- threadweaver/Mainpage.dox (revision 674698)
+++ threadweaver/Mainpage.dox (working copy)
@@ -1,4 +1,4 @@
-/*! \mainpage Introduction to ThreadWeaver
+/*! \mainpage ThreadWeaver - a Helper for Multithreaded Programming
\section UseCases Use Cases
@@ -219,3 +219,4 @@
Multithreaded Image Viewer (SMIV) example shows the use of job
dependencies.</p>
*/
+// DOXYGEN_SET_PROJECT_NAME = ThreadWeaver
Index: interfaces/kspeech/Mainpage.dox
===================================================================
--- interfaces/kspeech/Mainpage.dox (revision 674698)
+++ interfaces/kspeech/Mainpage.dox (working copy)
@@ -1,8 +1,6 @@
/**
- * @mainpage Introduction to the KSpeech D-Bus Interface
+ * @mainpage KSpeech - a D-Bus Interfaceto Text-to-Speech Service
*
- * kspeech - the KDE Text-to-Speech API.
- *
* @version 2.0 Draft 1
*
* @since KDE 4.0
Index: interfaces/khexedit/Mainpage.dox
===================================================================
--- interfaces/khexedit/Mainpage.dox (revision 674698)
+++ interfaces/khexedit/Mainpage.dox (working copy)
@@ -11,7 +11,7 @@
/** \file Mainpage.dox
\brief Introduction to the KHexEdit Interfaces
*/
-/** \mainpage Introduction to the KHexEdit Interfaces
+/** \mainpage KHexEdit - a Set of Interfaces For Byte Level Editing Services
\since KDE 3.2
Index: interfaces/ktexteditor/Mainpage.dox
===================================================================
--- interfaces/ktexteditor/Mainpage.dox (revision 674698)
+++ interfaces/ktexteditor/Mainpage.dox (working copy)
@@ -12,7 +12,7 @@
/** \file Mainpage.dox
\brief Introduction to the KTextEditor Interface
*/
-/** \mainpage Introduction to the KTextEditor Interface
+/** \mainpage KTextEditor - a Set of Interfaces for Advanced Plain Text Editing Services
\section kte_intro Introduction
The KTextEditor interfaces - also called KTE interfaces - are a set of
Index: kate/Mainpage.dox
===================================================================
--- kate/Mainpage.dox (revision 674698)
+++ kate/Mainpage.dox (working copy)
@@ -1,4 +1,4 @@
-/** @mainpage ./kate
+/** @mainpage Kate Editor Component
*
* The Kate Editor Component (also called Kate Part) implements the
* KTextEditor interfaces. Thus, all Kate Part classes are internal
Index: kfile/Mainpage.dox
===================================================================
--- kfile/Mainpage.dox (revision 674698)
+++ kfile/Mainpage.dox (working copy)
@@ -1,5 +1,5 @@
/*!
- * @mainpage kfile.
+ * @mainpage KFile - a Library Providing The File Selection Dialog And Its Components
*
* @section purpose Purpose
*
Index: kross/Mainpage.dox
===================================================================
--- kross/Mainpage.dox (revision 674698)
+++ kross/Mainpage.dox (working copy)
@@ -1,4 +1,4 @@
-/** @mainpage Kross
+/** @mainpage Kross - a Scripting Framework for Applications
*
* Kross is a scripting bridge to embed scripting functionality
* into an application. Kross provides an abstract API to access
@@ -42,3 +42,4 @@
*/
// DOXYGEN_REFERENCES = kdecore kdeui
+// DOXYGEN_SET_PROJECT_NAME = Kross
Index: phonon/Mainpage.dox
===================================================================
--- phonon/Mainpage.dox (revision 674698)
+++ phonon/Mainpage.dox (working copy)
@@ -1,4 +1,4 @@
-/** \mainpage The Phonon API.
+/** \mainpage Phonon - Multimedia API for KDE
%Phonon is the Multimedia API for %KDE. You should evaluate whether %Phonon
supplies all you need before looking at frameworks like GStreamer, NMM or Helix.
Index: kioslave/http/Mainpage.dox
===================================================================
--- kioslave/http/Mainpage.dox (revision 674698)
+++ kioslave/http/Mainpage.dox (working copy)
@@ -1,4 +1,4 @@
-/** @mainpage ./kioslave/http
+/** @mainpage HTTP KIO Slave
*
* Not much to say.
*/
Index: kioslave/Mainpage.dox
===================================================================
--- kioslave/Mainpage.dox (revision 674698)
+++ kioslave/Mainpage.dox (working copy)
@@ -3,7 +3,7 @@
* KIO Slaves are out-of-process worker applications that
* perform protocol-specific communications.
*
-* - <a href="../http/html/">http</a> ioslave
-* - ftp ioslave
+* @li <a href="../http/html/">http</a> ioslave
+* @li ftp ioslave
*
*/
Index: kinit/Mainpage.dox
===================================================================
--- kinit/Mainpage.dox (revision 674698)
+++ kinit/Mainpage.dox (working copy)
@@ -1,4 +1,4 @@
-/** @mainpage ./kinit
+/** @mainpage KInit - KDE Initialization Routines
*
* Not much to say.
*/
Index: nepomuk/Mainpage.dox
===================================================================
--- nepomuk/Mainpage.dox (revision 674722)
+++ nepomuk/Mainpage.dox (working copy)
@@ -398,3 +398,4 @@
* \endcode
*/
// DOXYGEN_EXCLUDE = core/resourcedata.h
+// DOXYGEN_SET_PROJECT_NAME = Nepomuk
Index: kimgio/Mainpage.dox
===================================================================
--- kimgio/Mainpage.dox (revision 674698)
+++ kimgio/Mainpage.dox (working copy)
@@ -1,4 +1,4 @@
-/** @mainpage ./kimgio
+/** @mainpage KImgIO - a Library Containing Routines for Reading/Writing Images
*
* Not much to say.
*/
Index: kio/Mainpage.dox
===================================================================
--- kio/Mainpage.dox (revision 674698)
+++ kio/Mainpage.dox (working copy)
@@ -1,5 +1,5 @@
/**
- * \mainpage A network-enabled file management system in a library
+ * \mainpage KIO - a Network-enabled File Management System in a Library
*
* This library implements almost all the file management functions you
* will ever need. In fact, the KDE file manager, Konqueror also uses
Index: kstyles/Mainpage.dox
===================================================================
--- kstyles/Mainpage.dox (revision 674698)
+++ kstyles/Mainpage.dox (working copy)
@@ -1,6 +1,7 @@
-/** @mainpage ./kstyles
+/** @mainpage KStyles - a Set of KDE Widget Styles
*
* Not much to say.
*/
// DOXYGEN_REFERENCES = kdecore kdefx
+// DOXYGEN_SET_PROJECT_NAME = KStyles
Index: kutils/Mainpage.dox
===================================================================
--- kutils/Mainpage.dox (revision 674698)
+++ kutils/Mainpage.dox (working copy)
@@ -1,4 +1,4 @@
-/** @mainpage ./kutils
+/** @mainpage KUtils - a Library Containing General KDE Utilities
*
* Not much to say.
*/
Index: kdesu/Mainpage.dox
===================================================================
--- kdesu/Mainpage.dox (revision 674698)
+++ kdesu/Mainpage.dox (working copy)
@@ -1,4 +1,4 @@
-/** @mainpage ./kdesu
+/** @mainpage KDEsu - a Library for Handling Authentication for Users and Processes
*
* Not much to say.
*/
Index: knewstuff/Mainpage.dox
===================================================================
--- knewstuff/Mainpage.dox (revision 674698)
+++ knewstuff/Mainpage.dox (working copy)
@@ -0,0 +1,3 @@
+/**
+ * \mainpage Collaborative Data Sharing in KDE applications
+ */
Index: khtml/design.h
===================================================================
--- khtml/design.h (revision 673723)
+++ khtml/design.h (working copy)
@@ -23,8 +23,6 @@
/**
- * \mainpage KDE HTML widget
- *
* This library provides a full-featured HTML parser and widget. It is
* used for rendering in all KDE applications which allow HTML viewing,
* including the Konqueror browser/file manager, KMail, and the KDE Help
Index: khtml/Mainpage.dox
===================================================================
--- khtml/Mainpage.dox (revision 674698)
+++ khtml/Mainpage.dox (working copy)
@@ -1,6 +1,5 @@
-/** @mainpage ./khtml
+/** @mainpage KDE HTML Parser and Widget
*
- * Not much to say.
*/
// DOXYGEN_REFERENCES = kdecore kdeui kio kdefx kparts kjs
// DOXYGEN_EXCLUDE = test*.* html rendering xml misc pics test
Index: kjs/wtf/Mainpage.dox
===================================================================
--- kjs/wtf/Mainpage.dox (revision 674698)
+++ kjs/wtf/Mainpage.dox (working copy)
@@ -1,4 +1,4 @@
-/** @mainpage ./wtf
+/** @mainpage The WTF Library
*
* Not much to say.
*/
Index: kjs/Mainpage.dox
===================================================================
--- kjs/Mainpage.dox (revision 674698)
+++ kjs/Mainpage.dox (working copy)
@@ -1,4 +1,4 @@
-/** @mainpage ./kjs
+/** @mainpage KJS - The KDE JavaScript/EcmaScript Engine in a Library
*
* Not much to say.
*/
Index: kdoctools/Mainpage.dox
===================================================================
--- kdoctools/Mainpage.dox (revision 674698)
+++ kdoctools/Mainpage.dox (working copy)
@@ -1,4 +1,4 @@
-/** @mainpage ./kdoctools
+/** @mainpage KDocTools - a Set of Tools Related to Documentation
*
* Not much to say.
*/
Index: sonnet/Mainpage.dox
===================================================================
--- sonnet/Mainpage.dox (revision 674698)
+++ sonnet/Mainpage.dox (working copy)
@@ -1,6 +1,7 @@
-/** @mainpage ./kspell2
+/** @mainpage Sonnet - The KDE Language Processing Architecture
*
* Not much to say.
*/
// DOXYGEN_REFERENCES = kdecore kdeui
+// DOXYGEN_SET_PROJECT_NAME = Sonnet
Index: kded/Mainpage.dox
===================================================================
--- kded/Mainpage.dox (revision 674698)
+++ kded/Mainpage.dox (working copy)
@@ -1,4 +1,4 @@
-/** @mainpage ./kded
+/** @mainpage kded - a Library for Handling KDE System Configuration Cache
*
* Not much to say.
*/
Index: solid/Mainpage.dox
===================================================================
--- solid/Mainpage.dox (revision 674698)
+++ solid/Mainpage.dox (working copy)
@@ -1,4 +1,4 @@
-/** @mainpage Solid
+/** @mainpage Solid - Device Integration Framework
*
* And for HAL's sake, each mistake, ah, you forgave
* And soon both of us learned to trust
@@ -17,3 +17,4 @@
*/
// DOXYGEN_EXCLUDE = solid/backends solid/ifaces tests
+// DOXYGEN_SET_PROJECT_NAME = Solid
Index: kdeprint/Mainpage.dox
===================================================================
--- kdeprint/Mainpage.dox (revision 674698)
+++ kdeprint/Mainpage.dox (working copy)
@@ -1,4 +1,4 @@
-/** @mainpage ./kdeprint
+/** @mainpage KDEPrint - a Library for Handling Printing Services
*
* Not much to say.
*/
Index: dnssd/Mainpage.dox
===================================================================
--- dnssd/Mainpage.dox (revision 674698)
+++ dnssd/Mainpage.dox (working copy)
@@ -1,4 +1,4 @@
-/** @mainpage ./dnssd
+/** @mainpage DNSSD - a Library for Handling DNS-SD, DNS-based Service Discovery Protocol
*
* Not much to say.
*/
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic