From 5366b34c41e6c043b700fe93be0261a46ffcded1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Rapinat?= Date: Fri, 27 May 2011 17:12:11 +0000 Subject: [PATCH] 4935: Update API documentation for Gramps 3.3.x; add localized handlers; start CLI and GUI svn: r17592 --- docs/corecli/cli.rst | 45 +++++++- docs/coregui/gui.rst | 147 +++++++++++++++++++++++- docs/date.rst | 259 ++++++++++++++++++++++++++++++++++++++++-- docs/relationship.rst | 125 +++++++++++++++++++- 4 files changed, 560 insertions(+), 16 deletions(-) diff --git a/docs/corecli/cli.rst b/docs/corecli/cli.rst index a27fe167f..4786a9b85 100644 --- a/docs/corecli/cli.rst +++ b/docs/corecli/cli.rst @@ -1,4 +1,45 @@ +########################## The :mod:`cli` Module -===================== +########################## -Todo +.. automodule:: cli + +***************************** +Argument Handler +***************************** +.. automodule:: cli.arghandler +.. autoclass:: ArgHandler + :members: + :undoc-members: + :show-inheritance: + +***************************** +Argument Parser +***************************** +.. automodule:: cli.argparser +.. autoclass:: ArgParser + :members: + :undoc-members: + :show-inheritance: + +***************************** +CLI DB manager +***************************** +.. automodule:: cli.clidbman +.. autoclass:: CLIDbManager + :members: + :undoc-members: + :show-inheritance: + +***************************** +Gramps CLI +***************************** +.. automodule:: cli.grampscli +.. autoclass:: CLIDbLoader + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: CLIManager + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/coregui/gui.rst b/docs/coregui/gui.rst index a10d45b5e..f982d251d 100644 --- a/docs/coregui/gui.rst +++ b/docs/coregui/gui.rst @@ -1,4 +1,149 @@ +########################## The :mod:`gui` Module -===================== +########################## +.. automodule:: gui + +***************************** +About Dialog +***************************** +.. automodule:: gui.aboutdialog +.. autoclass:: AuthorParser + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: GrampsAboutDialog + :members: + :undoc-members: + :show-inheritance: + +***************************** +Base Sidebar +***************************** +.. automodule:: gui.basesidebar +.. autoclass:: BaseSidebar + :members: + :undoc-members: + :show-inheritance: + +***************************** +Column Order +***************************** +.. automodule:: gui.columnorder +.. autoclass:: ColumnOrder + :members: + :undoc-members: + :show-inheritance: + +***************************** +Configuration +***************************** +.. automodule:: gui.configure +.. autoclass:: ConfigureDialog + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: DisplayNameEditor + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: GrampsPreferences + :members: + :undoc-members: + :show-inheritance: + +***************************** +GUI Element (DB) +***************************** +.. automodule:: gui.dbguielement +.. autoclass:: DbGUIElement + :members: + :undoc-members: + :show-inheritance: + +***************************** +DB Loader +***************************** +.. automodule:: gui.dbloader +.. autoclass:: DbLoader + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: GrampsFormatWidget + :members: + :undoc-members: + :show-inheritance: + +***************************** +DB Manager +***************************** +.. automodule:: gui.dbman +.. autoclass:: DbManager + :members: + :undoc-members: + :show-inheritance: + +***************************** +Filter Editor +***************************** +.. automodule:: gui.filtereditor +.. autoclass:: EditFilter + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: EditRule + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: FilterEditor + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: MyBoolean + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: MyEntry + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: MyFilters + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: MyID + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: MyInteger + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: MyLesserEqualGreater + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: MyList + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: MyPlaces + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: MySelect + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: MySource + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: ShowResults + :members: + :undoc-members: + :show-inheritance: + +***************************** Todo +***************************** diff --git a/docs/date.rst b/docs/date.rst index 185ffe46d..361119384 100644 --- a/docs/date.rst +++ b/docs/date.rst @@ -2,9 +2,13 @@ The :class:`Date Handler` Classes ######################################### -Contents: - -.. automodule:: DateHandler +DateParser +==================================== +.. automodule:: DateHandler._DateParser +.. autoclass:: DateParser + :members: + :undoc-members: + :show-inheritance: DateDisplay ==================================== @@ -13,19 +17,252 @@ DateDisplay :members: :undoc-members: :show-inheritance: - -DateDisplay (English) -==================================== -.. automodule:: DateHandler._DateDisplayEn .. autoclass:: DateDisplayEn :members: :undoc-members: :show-inheritance: - -DateParser + +DateUtils ==================================== -.. automodule:: DateHandler._DateParser -.. autoclass:: DateParser +.. automodule:: DateHandler._DateUtils + :members: + :undoc-members: + :show-inheritance: + +DateHandler +==================================== +.. automodule:: DateHandler._DateHandler + :members: + :undoc-members: + :show-inheritance: + +Localized Date Handlers +==================================== + +***************************** +DateHandler (Bulgarian) +***************************** +.. autoclass:: DateHandler._Date_bg.DateParserBG + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: DateHandler._Date_bg.DateDisplayBG + :members: + :undoc-members: + :show-inheritance: + +***************************** +DateHandler (Catalan) +***************************** +.. autoclass:: DateHandler._Date_ca.DateParserCA + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: DateHandler._Date_ca.DateDisplayCA + :members: + :undoc-members: + :show-inheritance: + +***************************** +DateHandler (Czech) +***************************** +.. autoclass:: DateHandler._Date_cs.DateParserCZ + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: DateHandler._Date_cs.DateDisplayCZ + :members: + :undoc-members: + :show-inheritance: + +***************************** +DateHandler (German) +***************************** +.. autoclass:: DateHandler._Date_de.DateParserDE + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: DateHandler._Date_de.DateDisplayDE + :members: + :undoc-members: + :show-inheritance: + +***************************** +DateHandler (Spanish) +***************************** +.. autoclass:: DateHandler._Date_es.DateParserES + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: DateHandler._Date_es.DateDisplayES + :members: + :undoc-members: + :show-inheritance: + +***************************** +DateHandler (Finnish) +***************************** +.. autoclass:: DateHandler._Date_fi.DateParserFI + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: DateHandler._Date_fi.DateDisplayFI + :members: + :undoc-members: + :show-inheritance: + +***************************** +DateHandler (French) +***************************** +.. autoclass:: DateHandler._Date_fr.DateParserFR + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: DateHandler._Date_fr.DateDisplayFR + :members: + :undoc-members: + :show-inheritance: + +***************************** +DateHandler (Croatian) +***************************** +.. autoclass:: DateHandler._Date_hr.DateParserHR + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: DateHandler._Date_hr.DateDisplayHR + :members: + :undoc-members: + :show-inheritance: + +***************************** +DateHandler (Italian) +***************************** +.. autoclass:: DateHandler._Date_it.DateParserIT + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: DateHandler._Date_it.DateDisplayIT + :members: + :undoc-members: + :show-inheritance: + +***************************** +DateHandler (Lituanian) +***************************** +.. autoclass:: DateHandler._Date_lt.DateParserLT + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: DateHandler._Date_lt.DateDisplayLT + :members: + :undoc-members: + :show-inheritance: + +***************************** +DateHandler (Norwegian) +***************************** +.. autoclass:: DateHandler._Date_nb.DateParserNb + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: DateHandler._Date_nb.DateDisplayNb + :members: + :undoc-members: + :show-inheritance: + +***************************** +DateHandler (Dutch) +***************************** +.. autoclass:: DateHandler._Date_nl.DateParserNL + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: DateHandler._Date_nl.DateDisplayNL + :members: + :undoc-members: + :show-inheritance: + +***************************** +DateHandler (Polish) +***************************** +.. autoclass:: DateHandler._Date_pl.DateParserPL + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: DateHandler._Date_pl.DateDisplayPL + :members: + :undoc-members: + :show-inheritance: + +***************************** +DateHandler (Portuguese) +***************************** +.. autoclass:: DateHandler._Date_pt.DateParserPT + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: DateHandler._Date_pt.DateDisplayPT + :members: + :undoc-members: + :show-inheritance: + +***************************** +DateHandler (Russian) +***************************** +.. autoclass:: DateHandler._Date_ru.DateParserRU + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: DateHandler._Date_ru.DateDisplayRU + :members: + :undoc-members: + :show-inheritance: + +***************************** +DateHandler (Slovak) +***************************** +.. autoclass:: DateHandler._Date_sk.DateParserSK + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: DateHandler._Date_sk.DateDisplaySK + :members: + :undoc-members: + :show-inheritance: + +***************************** +DateHandler (Slovenian) +***************************** +.. autoclass:: DateHandler._Date_sl.DateParserSL + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: DateHandler._Date_sl.DateDisplaySL + :members: + :undoc-members: + :show-inheritance: + +***************************** +DateHandler (Serbian) +***************************** +.. autoclass:: DateHandler._Date_sr.DateParserSR + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: DateHandler._Date_sr.DateDisplaySR_latin + :members: + :undoc-members: + :show-inheritance: + +***************************** +DateHandler (Swedish) +***************************** +.. autoclass:: DateHandler._Date_sv.DateParserSv + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: DateHandler._Date_sv.DateDisplaySv :members: :undoc-members: :show-inheritance: diff --git a/docs/relationship.rst b/docs/relationship.rst index 1e3808e2b..d82633bf0 100644 --- a/docs/relationship.rst +++ b/docs/relationship.rst @@ -2,10 +2,131 @@ The :class:`RelationshipCalculator` Class ######################################### -Contents: - .. automodule:: Relationship .. autoclass:: RelationshipCalculator :members: :undoc-members: :show-inheritance: + +***************************** +Localized Handlers +***************************** + +Relationship (Czech) +==================================== +.. autoclass:: rel_cs.RelationshipCalculator + :members: + :undoc-members: + :show-inheritance: + +Relationship (Danish) +==================================== +.. autoclass:: rel_da.RelationshipCalculator + :members: + :undoc-members: + :show-inheritance: + +Relationship (German) +==================================== +.. autoclass:: rel_de.RelationshipCalculator + :members: + :undoc-members: + :show-inheritance: + +Relationship (Spanish) +==================================== +.. autoclass:: rel_es.RelationshipCalculator + :members: + :undoc-members: + :show-inheritance: + +Relationship (Finnish) +==================================== +.. autoclass:: rel_fi.RelationshipCalculator + :members: + :undoc-members: + :show-inheritance: + +Relationship (French) +==================================== +.. autoclass:: rel_fr.RelationshipCalculator + :members: + :undoc-members: + :show-inheritance: + +Relationship (Croatian) +==================================== +.. autoclass:: rel_hr.RelationshipCalculator + :members: + :undoc-members: + :show-inheritance: + +Relationship (Hungarian) +==================================== +.. autoclass:: rel_hu.RelationshipCalculator + :members: + :undoc-members: + :show-inheritance: + +Relationship (Italian) +==================================== +.. autoclass:: rel_it.RelationshipCalculator + :members: + :undoc-members: + :show-inheritance: + +Relationship (Dutch) +==================================== +.. autoclass:: rel_nl.RelationshipCalculator + :members: + :undoc-members: + :show-inheritance: + +Relationship (Norwegian) +==================================== +.. autoclass:: rel_no.RelationshipCalculator + :members: + :undoc-members: + :show-inheritance: + +Relationship (Polish) +==================================== +.. autoclass:: rel_pl.RelationshipCalculator + :members: + :undoc-members: + :show-inheritance: + +Relationship (Portuguese) +==================================== +.. autoclass:: rel_pt.RelationshipCalculator + :members: + :undoc-members: + :show-inheritance: + +Relationship (Russian) +==================================== +.. autoclass:: rel_ru.RelationshipCalculator + :members: + :undoc-members: + :show-inheritance: + +Relationship (Slovak) +==================================== +.. autoclass:: rel_sk.RelationshipCalculator + :members: + :undoc-members: + :show-inheritance: + +Relationship (Slovenian) +==================================== +.. autoclass:: rel_sl.RelationshipCalculator + :members: + :undoc-members: + :show-inheritance: + +Relationship (Swedish) +==================================== +.. autoclass:: rel_sv.RelationshipCalculator + :members: + :undoc-members: + :show-inheritance: