[bt-devel] patch for comments
Holger Schurig
bt-devel@crosswire.org
Tue, 17 Jul 2001 23:46:11 +0200
--------------Boundary-00=_ZG0NBMVVUYK0T7DOAVAK
Content-Type: text/plain;
charset="iso-8859-1"
Content-Transfer-Encoding: 8bit
The following patch changes some veeeeery long lines with comments into
smaller ones (<80 lines).
It also added some missing descriptions at the top of files.
Greetings,
Holger
--
Holger Schurig
Gartenstr. 26
61206 Ober-Wöllstadt
06034-906230
--------------Boundary-00=_ZG0NBMVVUYK0T7DOAVAK
Content-Type: text/x-diff;
charset="iso-8859-1";
name="comment.patch"
Content-Transfer-Encoding: quoted-printable
Content-Disposition: attachment; filename="comment.patch"
diff -u -r1.22 bibletime.cpp
--- bibletime/bibletime.cpp=092001/07/16 19:33:14=091.22
+++ bibletime/bibletime.cpp=092001/07/17 21:43:48
@@ -248,7 +248,7 @@
/** Refreshes all presenter supporting at least in of the features given=
as parameter.*/
void BibleTime::refreshPresenters( int useFeatures ) {
=09/*
-=09*=09Iterate through all features and test their support by the psente=
rs.
+=09*=09Iterate through all features and test their support by the presen=
ters.
=09*=09If the feature is supported refresh the presenter and continue.
=09*/=09=09
=09unsigned int index;=09=09=09=09
@@ -272,7 +272,9 @@
=09return true;
}
=20
-/** No descriptions */
+/** Called when the main window and all of it's contents should be displ=
ay.
+ * This also means that we're fully initialized.
+ */
void BibleTime::show(){
=09KMainWindow::show();=09
=09//if we show BibleTime for the first time we are ready for processing
Index: bibletime/bibletime.h
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
RCS file: /cvsroot/bibletime/bibletime/bibletime/bibletime.h,v
retrieving revision 1.19
diff -u -r1.19 bibletime.h
--- bibletime/bibletime.h=092001/07/01 18:34:28=091.19
+++ bibletime/bibletime.h=092001/07/17 21:43:48
@@ -1,5 +1,5 @@
/**********************************************************************=
*****
- bibletime.h - description
+ bibletime.h - The main window
-------------------
begin : Mit Jan 19 12:57:15 CET 2000
copyright : (C) 2000 by The BibleTime Team
@@ -48,55 +48,76 @@
/**
=09*=09@page backend The structure of the backend
=09*
- =09*=09The backend implementation for Sword is called CSwordBackend, th=
e classes we use
- =09* to work with keys are called CSwordVerseKey and CSwordLDKey, both =
are derived from
- =09* the class CSwordKey.
- =09* The CSwordKey derived classes used for Sword do also inherit the c=
lasses VerseKey (CSwordVerseKey)
- =09*=09and SWKey (CSwordLDKey).
+ =09*=09The backend implementation for Sword is called CSwordBackend, th=
e classes
+ * we use to work with keys are called CSwordVerseKey and CSwordLDKey (=
LD
+ * means Lexicon & Dictionary), both are derived from the class CSwordK=
ey.
+ * The CSwordKey derived classes used for Sword do also inherit the cla=
sses
+ * VerseKey (CSwordVerseKey) and SWKey (CSwordLDKey).
=09*=09
- =09*=09The classes used to handle all module based stuff are derived fr=
om CModuleInfo.
- =09*=09The module classes are: CSwordModuleInfo (for Sword modules), CS=
wordBibleModuleInfo (for bibles), CSwordCommentaryModuleInfo (for comment=
aries) and
- =09*=09CSwordLexiconModuleInfo (for lexicons).
- =09*=09Have a look at the class documentation of the mentioned classes =
to learn how the
- =09*=09structure of them looks like and which class inherits which othe=
r class.
+ =09*=09The classes used to handle all module based stuff are derived fr=
om
+ * CModuleInfo. The module classes are: CSwordModuleInfo (for Sword mod=
ules),
+ * CSwordBibleModuleInfo (for bibles), CSwordCommentaryModuleInfo (for
+ * commentaries) and CSwordLexiconModuleInfo (for lexicons).
+ =09*=09Have a look at the class documentation of the mentioned classes =
to learn
+ * how the structure of them looks like and which class inherits which =
other
+ * class.
=09*
- =09*=09The first objects which should be created in the application is =
the backend (for Sword the class is called CSwordBackend).
- =09*=09Then create all the different module classes for the correct Swo=
rd modules. Have a look at
- =09* BibleTime::initBackens() to see how it's done in BibleTime.@br
- =09*=09Later you can work with them for example by using the CSwordKey =
and CSwordModuleInfo derived class.
+ =09*=09The first objects which should be created in the application is =
the
+ * backend (for Sword the class is called CSwordBackend). Then create a=
ll
+ * the different module classes for the correct Sword modules. Have a l=
ook
+ * at BibleTime::initBackends() to see how it's done in BibleTime.
+ *
+ =09*=09Later you can work with them for example by using the CSwordKey =
and
+ * CSwordModuleInfo derived class.
=09*/
=20
/**
=09*=09@page frontend The structure of the frontend
=09*=09
- =09*
- =09*=09The frontend contains the classes which interact with the user. =
For example the main index,
- =09* the display windows, the searchdialog or the other parts.
- =09* The main index is implemented in the class CGroupManager, the item=
s of the main index are implemented in the class CGroupManagerItem.
- =09* Each CGroupManagerItem has a type() function which returns the typ=
e of the object (Module, Bookmark or Group).<BR>
- =09* The display windows are all derived from the base class CPresenter=
=2E The display windows which handle Sword modules are all derived from t=
he CSwordPresenter class.
- =09* The display windows which provide functionality are CBiblePresente=
r for Bibles, CCommentaryPresenter for commentaries and CLexiconPresenter=
for lexicon and dictionaries.
- =09* CSwordPresenter provides the essential base functions which are re=
implemented in the derived classes (for example CSwordPresenter::lookup).=
<BR>
- =09* Another important part of the frontend are the keychoosers. They p=
rovide an interface to choose a key of a module. The interface for differ=
ent module types is different.
- =09* The base class is CKeyChooser which is the factory for the derived=
classes. Use the function CKeyChooser::createInstance to get the correct
- =09* keychooser implementation for the desired module.<BR>
+ =09*=09The frontend contains the classes which interact with the user. =
For
+ * example the main index, the display windows, the searchdialog or the
+ * other parts. The main index is implemented in the class CGroupManage=
r,
+ * the items of the main index are implemented in the class
+ * CGroupManagerItem. Each CGroupManagerItem has a type() function whic=
h
+ * returns the type of the object (Module, Bookmark or Group).
+ *
+ =09* The display windows are all derived from the base class CPresenter=
=2E
+ * The display windows which handle Sword modules are all derived from
+ * the CSwordPresenter class. The display windows which provide
+ * functionality are CBiblePresenter for Bibles, CCommentaryPresenter
+ * for commentaries and CLexiconPresenter for lexicon and dictionaries.
+ =09* CSwordPresenter provides the essential base functions which are
+ * reimplemented in the derived classes (for example
+ * CSwordPresenter::lookup).
+ *
+ =09* Another important part of the frontend are the keychoosers. They p=
rovide
+ * an interface to choose a key of a module. The interface for differen=
t
+ * module types is different. The base class is CKeyChooser which is th=
e
+ * factory for the derived classes. Use the function
+ * CKeyChooser::createInstance to get the correct keychooser implementa=
tion
+ * for the desired module.
=09*/
=20
/** @mainpage BibleTime 1.0 - sourcecode documentation
+ *
+ *=09This is the sourcecode documentation of BibleTime, a Bible study to=
ol
+ * for KDE/Linux. BibleTime is devided in two major parts, the backend =
and
+ * the frontend.
*
- *=09This is the sourcecode documentation of BibleTime, a Bible study to=
ol for KDE/Linux.
- *=09BibleTime is devided in two major parts, the backend and the fronte=
nd.<BR>
- *=09Documentation for the backend: @ref backend<BR>
- *=09Documentation for the frontend: @ref frontend.<BR>
+ *=09Documentation for the backend: @ref backend
+ *
+ *=09Documentation for the frontend: @ref frontend.
*/
=20
/** The main class of BibleTime. Here are the main widgets created.
=09*
-=09* This is the main class of BibleTime! This class creates the GUI, th=
e KAction objects
-=09* and connects to some slots. Please insert the creation of actions i=
n initActions,
-=09* the creation of widgets into initView and the connect(...) calls in=
to initConnections.
-=09* Reading from a config file on creation time should go into readSett=
ings(), saving into
-=09* saveSettings().
+=09* This is the main class of BibleTime! This class creates the GUI, th=
e
+ * KAction objects and connects to some slots. Please insert the creati=
on
+ * of actions in initActions, the creation of widgets into initView and
+ * the connect(...) calls into initConnections. Reading from a config f=
ile
+ * on creation time should go into readSettings(), saving into
+ * saveSettings().
+ *
=09* This is the general way of all BibleTime classes.
=09*/
class BibleTime : public KMainWindow {
@@ -112,7 +133,8 @@
*/
virtual ~BibleTime();
/**
- * No descriptions
+ * Called when the main window and all of it's contents should be displ=
ay.
+ * This also means that we're fully initialized.
*/
virtual void show();
/**
@@ -245,6 +267,7 @@
=09QSplitter* m_splitter;
=09CGroupManager* m_groupmanager;
=09CMDIArea* m_mdi;
+
/**
* The list of installed SWORD modules
*/
@@ -260,10 +283,11 @@
void slotFileQuit();
/**
=09* Creates a new presenter in the MDI area according to the type of t=
he module.
+ * It will take the first module from the module list.
=09*/
void createNewSwordPresenter(ListCSwordModuleInfo,const QString);
/**
- * No descriptions
+ * Dito, but expects the module directly, not inside a list
*/
void createNewSwordPresenter(CSwordModuleInfo*, const QString );
/**
@@ -321,7 +345,7 @@
=20
private slots: // Private slots
/**
- * No descriptions
+ * One entry was printed
*/
void slotPrintedEntry( const QString& key, const int index);
/**
Index: bibletime/bibletime_init.cpp
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
RCS file: /cvsroot/bibletime/bibletime/bibletime/bibletime_init.cpp,v
retrieving revision 1.30
diff -u -r1.30 bibletime_init.cpp
--- bibletime/bibletime_init.cpp=092001/07/16 19:33:14=091.30
+++ bibletime/bibletime_init.cpp=092001/07/17 21:43:48
@@ -288,14 +288,15 @@
=09=09=09case CSwordBackend::noModulesAvailable:=09=09=09
=09=09=09=09HTML_DIALOG(HELPDIALOG_NO_SWORD_MODULES);
=09=09=09=09break;
-// --- The following pages are not yet available ---
-/*=09=09=09case CSwordBackend::noSwordConfigFile:
-=09=09=09=09HTML_DIALOG(HELPDIALOG_NO_SWORD_CONFIG);
+// TODO: The following pages are not yet available
+ =09=09case CSwordBackend::noSwordConfigFile:
+=09=09=09 qWarning("The programmer did not write the page for noSwordCo=
nfigFile");
+=09=09=09=09// HTML_DIALOG(HELPDIALOG_NO_SWORD_CONFIG);
=09=09=09=09break;
=09=09=09case CSwordBackend::noSwordModuleDirectory:
-=09=09=09=09HTML_DIALOG(HELPDIALOG_NO_SWORD_MODULES_DIR);
+=09=09=09 qWarning("The programmer did not write the page for noSwordMo=
duleDirectory");
+=09=09=09=09//HTML_DIALOG(HELPDIALOG_NO_SWORD_MODULES_DIR);
=09=09=09=09break;=09=09
-*/
=09=09=09case CSwordBackend::noSwordModuleConfigDirectory:
=09=09=09=09HTML_DIALOG(HELPDIALOG_NO_SWORD_MODULE_CONFIG_DIR);=09=09=09=
=09
=09=09=09=09break;=09=09=09=09=09=09
Index: bibletime/bibletime_slots.cpp
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
RCS file: /cvsroot/bibletime/bibletime/bibletime/bibletime_slots.cpp,v
retrieving revision 1.23
diff -u -r1.23 bibletime_slots.cpp
--- bibletime/bibletime_slots.cpp=092001/07/01 04:58:50=091.23
+++ bibletime/bibletime_slots.cpp=092001/07/17 21:43:49
@@ -1,5 +1,5 @@
/***********************************************************************=
****
- bibletime_slots.cpp - description
+ bibletime_slots.cpp - Code for most slots
-------------------
begin : Wed Jan 19 2000
copyright : (C) 2000 by The BibleTime Team
@@ -69,14 +69,15 @@
#if KDE_VERSION >=3D 193
=09KMainWindow* w;
#else
-=09#warning You are using a KDE Beta release!
+=09#warning You are using an old KDE release!
=09KTMainWindow* w;
#endif
=20
=09if(memberList){
=09=09for(w =3D memberList->first(); w; w =3D memberList->first()){
-=09=09=09// only close the window if the closeEvent is accepted. If the =
user presses Cancel on the saveModified() dialog,
-=09=09=09// the window and the application stay open.
+=09=09=09// only close the window if the closeEvent is accepted. If the =
user
+ // presses Cancel on the saveModified() dialog, the window and the
+ // application stay open.
=09=09=09if(!w->close())
=09=09=09=09break;
=09=09}
@@ -162,14 +163,14 @@
=09refreshPresenters( CSwordPresenter::strongNumbersChanged );
}
=20
-/** Switches footnotes on or off */
+/** Switches headings of modules on or off */
void BibleTime::slotToggleHeadings(){
=09m_important->swordBackend->setOption(CSwordBackend::headings, m_viewH=
eadings_action->isChecked() );
=09
=09refreshPresenters( CSwordPresenter::headingsChanged );
}
=20
-/** Switches footnotes on or off */
+/** Switches morphological tags on or off */
void BibleTime::slotToggleMorphTags(){
=09m_important->swordBackend->setOption(CSwordBackend::morphTags, m_view=
MorphTags_action->isChecked() );
=09
@@ -320,7 +321,7 @@
=09pthread_mutex_destroy(&progress_mutex);
}
=20
-/** No descriptions */
+/** One was printed */
void BibleTime::slotPrintedEntry( const QString& key, const int index){
=09if (pthread_mutex_trylock(&progress_mutex) =3D=3D EBUSY)
=09=09return;=09=09
@@ -338,7 +339,9 @@
=09=09slotPrintingFinished();
}
=20
-/** Opens the online help. If STATIC_BUILD is defined it opens an own di=
alog, otherwise the standard KDE helpsystem will be opened. */
+/** Opens the online help. If STATIC_BUILD is defined it opens an own di=
alog,
+ * otherwise the standard KDE helpsystem will be opened.
+ */
void BibleTime::openOnlineHelp() {
#ifdef STATIC_BUILD
=09CHTMLDialog dlg("bibletime/index.html");
Index: bibletime/main.cpp
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
RCS file: /cvsroot/bibletime/bibletime/bibletime/main.cpp,v
retrieving revision 1.33
diff -u -r1.33 main.cpp
--- bibletime/main.cpp=092001/07/17 14:27:55=091.33
+++ bibletime/main.cpp=092001/07/17 21:43:49
@@ -96,7 +96,7 @@
=09aboutData.addAuthor("Martin Gruner", =09I18N_NOOP("Frontend, backend,=
misc things"), "mg.pub@gmx.net", "");
=09aboutData.addAuthor("Chris Kujawa", =09I18N_NOOP("Frontend"),"christo=
pher.kujawa@verizon.net", "");
=09aboutData.addAuthor("Luke Mauldin", =09I18N_NOOP("Frontend"),"lukesky=
fly@txk.net", "");
-=09aboutData.addAuthor("Tim Brodie", =09I18N_NOOP("Installation manager"=
),"tbrodie@displayworksinc.com", "");
+=09aboutData.addAuthor("Tim Brodie", =09 I18N_NOOP("Installation manage=
r"),"tbrodie@displayworksinc.com", "");
=20
=09//documentation
=09aboutData.addAuthor("Fred Saalbach", =09I18N_NOOP("Handbook"), "saalb=
ach@sybercom.net", "");=09=09
@@ -107,24 +107,24 @@
=09aboutData.addAuthor("Mario Bertrand", =09 I18N_NOOP("Translation int=
o French"), "mbert@tbrq.org", "");=09=09=09
=09aboutData.addAuthor("Benedykt P. Barszcz",I18N_NOOP("Translation into=
Polish"), "kb2qzv@box43.gnet.pl", "");=09=09
=09aboutData.addAuthor("Birger Langkjer", =09=09I18N_NOOP("Translation i=
nto Danish"), "birger.langkjer@image.dk", "");=09=09=09=09
-=09aboutData.addAuthor("Zdeno Podobny", =09=09I18N_NOOP("Translation int=
o Slovak"), "zdpo@post.sk", "");=09
+=09aboutData.addAuthor("Zdeno Podobny", =09=09 I18N_NOOP("Translation i=
nto Slovak"), "zdpo@post.sk", "");=09
=09aboutData.addAuthor("Michal Rovnan=EDk",=09=09I18N_NOOP("Translation =
into Czech"), "Michal.Rovnanik@seznam.cz", "");=09=09=09
-=09aboutData.addAuthor("Eduardo Sanchez", =09=09=09I18N_NOOP("Translatio=
n into Spanish"), "csanche2@calvin.edu", "");=09=09=09
+=09aboutData.addAuthor("Eduardo Sanchez", =09=09I18N_NOOP("Translation i=
nto Spanish"), "csanche2@calvin.edu", "");=09=09=09
=09aboutData.addAuthor("Beda Szukics",=09=09=09=09I18N_NOOP("Translation=
into Italian"), "bszukics@bluewin.ch", "");=09=09=09=09=09=09=09=09
=09aboutData.addAuthor("Balint Sandor", =09=09=09I18N_NOOP("Translation =
into Hungarian"), "balintsa@freemail.hu", "");=09=09=09=09
=09aboutData.addAuthor("Espen Trydal", =09=09=09I18N_NOOP("Translation i=
nto Norwegian"), "etrydal@postkassa.no", "");=09=09
-//=09aboutData.addAuthor("Jonathan Jones",=09=09=09I18N_NOOP("Translatio=
n into Brazilian Portoguese"), "jones@brfree.com.br", "");=09=09=09=09=09
-//=09aboutData.addAuthor("Walter Rodrigo de S=E1 Cruz",=09=09=09I18N_NOO=
P("Translation into Portoguese"), "keytech@ig.com.br", "");=09=09
+//aboutData.addAuthor("Jonathan Jones",=09=09=09I18N_NOOP("Translation i=
nto Brazilian Portoguese"), "jones@brfree.com.br", "");=09=09=09=09=09
+//aboutData.addAuthor("Walter Rodrigo de S=E1 Cruz",=09=09=09I18N_NOOP("=
Translation into Portoguese"), "keytech@ig.com.br", "");=09=09
=09aboutData.addAuthor("Kees van Veen", =09=09=09I18N_NOOP("Translation =
into Dutch"), "cvn@interchain.nl", "");=09
=09=09=09=09=09=09=09=09=09=09=09=09=09=09=09
=09//credits
-=09aboutData.addCredit("Bob Harman", =09I18N_NOOP("Bible study HowTo"), =
"N_Cov_Church@compuserve.com", "");=09=09
-=09aboutData.addCredit("Darwin Gregory", I18N_NOOP("Optionsdialog"), "da=
rwin@ichristian.com", "");=09=09
-=09aboutData.addCredit("Jeffrey Hoyt", =09I18N_NOOP("handbook"), "jeffho=
yt@earthlink.net", "http://jhoyt.faithweb.com");=09
-=09aboutData.addCredit("Juho Vahakangas", I18N_NOOP("Martin Luther start=
up logo"), "juhov@freenet.fi", "");
-=09aboutData.addCredit("Thomas Hagedorn", I18N_NOOP("Sponsor of www.bibl=
etime.de"), "tom@delix.de", "");=09=09
-=09aboutData.addCredit("Torsten Uhlmann", I18N_NOOP("backend"), "TUhlman=
n@gmx.de", "http://tuhlmann.purespace.de");
-=09aboutData.addCredit("Troy A. Griffits", I18N_NOOP("Leader of the SWOR=
D project.\nLots of help with the SWORD API!"), "scribe@crosswire.org", "=
");=09
+=09aboutData.addCredit("Bob Harman", =09 I18N_NOOP("Bible study How=
To"), "N_Cov_Church@compuserve.com", "");=09=09
+=09aboutData.addCredit("Darwin Gregory", I18N_NOOP("Optionsdialog"),=
"darwin@ichristian.com", "");=09=09
+=09aboutData.addCredit("Jeffrey Hoyt", =09 I18N_NOOP("handbook"), "je=
ffhoyt@earthlink.net", "http://jhoyt.faithweb.com");=09
+=09aboutData.addCredit("Juho Vahakangas", I18N_NOOP("Martin Luther st=
artup logo"), "juhov@freenet.fi", "");
+=09aboutData.addCredit("Thomas Hagedorn", I18N_NOOP("Sponsor of www.b=
ibletime.de"), "tom@delix.de", "");=09=09
+=09aboutData.addCredit("Torsten Uhlmann", I18N_NOOP("backend"), "TUhl=
mann@gmx.de", "http://tuhlmann.purespace.de");
+=09aboutData.addCredit("Troy A. Griffits", I18N_NOOP("Leader of the SW=
ORD project.\nLots of help with the SWORD API!"), "scribe@crosswire.org",=
"");=09
=09
=09KCrash::setEmergencySaveFunction( emergencySave ); =09
=09 =09
Index: bibletime/ressource.h
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
RCS file: /cvsroot/bibletime/bibletime/bibletime/ressource.h,v
retrieving revision 1.17
diff -u -r1.17 ressource.h
--- bibletime/ressource.h=092001/07/14 21:25:25=091.17
+++ bibletime/ressource.h=092001/07/17 21:43:50
@@ -1,5 +1,5 @@
/***********************************************************************=
****
- ressource.h - description
+ ressource.h - resource IDs and texts
-------------------
begin : Wed Jan 19 2000
copyright : (C) 2000 by The BibleTime Team
--------------Boundary-00=_ZG0NBMVVUYK0T7DOAVAK--