From 17350a8c2f3aa77ac80903bc31caf71260ad6c37 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Rapinat?= Date: Thu, 19 Jul 2012 08:55:23 +0000 Subject: [PATCH] update APIs documentation according to last changes (GEPS008) svn: r20032 --- docs/api.rst | 1 - docs/coregui/gui.rst | 2 +- docs/date.rst | 126 ++++++++++++++++++++--------------------- docs/gen/gen.rst | 54 ++++++++++++++++++ docs/gen/gen_proxy.rst | 4 -- docs/gen/gen_utils.rst | 50 +++++++++++++++- docs/relationship.rst | 2 +- docs/simple.rst | 8 +-- docs/utils.rst | 12 ---- 9 files changed, 172 insertions(+), 87 deletions(-) delete mode 100644 docs/utils.rst diff --git a/docs/api.rst b/docs/api.rst index 0ba319cf4..2bbeb6f0e 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -35,7 +35,6 @@ Contents: date relationship simple - utils Usefull snippets =================== diff --git a/docs/coregui/gui.rst b/docs/coregui/gui.rst index d935d8aa3..d7ee22983 100644 --- a/docs/coregui/gui.rst +++ b/docs/coregui/gui.rst @@ -95,7 +95,7 @@ DB Manager ***************************** Filter Editor ***************************** -.. automodule:: gui.filtereditor +.. automodule:: gui.editors.filtereditor .. autoclass:: EditFilter :members: :undoc-members: diff --git a/docs/date.rst b/docs/date.rst index 4726ea8f1..9c37d3199 100644 --- a/docs/date.rst +++ b/docs/date.rst @@ -4,7 +4,7 @@ The :class:`Date Handler` Classes DateParser ==================================== -.. automodule:: DateHandler._DateParser +.. automodule:: gen.datehandler._dateparser .. autoclass:: DateParser :members: :undoc-members: @@ -12,7 +12,7 @@ DateParser DateDisplay ==================================== -.. automodule:: DateHandler._DateDisplay +.. automodule:: gen.datehandler._datedisplay .. autoclass:: DateDisplay :members: :undoc-members: @@ -24,14 +24,14 @@ DateDisplay DateUtils ==================================== -.. automodule:: DateHandler._DateUtils +.. automodule:: gen.datehandler._dateutils :members: :undoc-members: :show-inheritance: -DateHandler +datehandler ==================================== -.. automodule:: DateHandler._DateHandler +.. automodule:: gen.datehandler._datehandler :members: :undoc-members: :show-inheritance: @@ -40,229 +40,229 @@ Localized Date Handlers ==================================== ***************************** -DateHandler (Bulgarian) +datehandler (Bulgarian) ***************************** -.. autoclass:: DateHandler._Date_bg.DateParserBG +.. autoclass:: gen.datehandler._date_bg.DateParserBG :members: :undoc-members: :show-inheritance: -.. autoclass:: DateHandler._Date_bg.DateDisplayBG +.. autoclass:: gen.datehandler._date_bg.DateDisplayBG :members: :undoc-members: :show-inheritance: ***************************** -DateHandler (Catalan) +datehandler (Catalan) ***************************** -.. autoclass:: DateHandler._Date_ca.DateParserCA +.. autoclass:: gen.datehandler._date_ca.DateParserCA :members: :undoc-members: :show-inheritance: -.. autoclass:: DateHandler._Date_ca.DateDisplayCA +.. autoclass:: gen.datehandler._date_ca.DateDisplayCA :members: :undoc-members: :show-inheritance: ***************************** -DateHandler (Czech) +datehandler (Czech) ***************************** -.. autoclass:: DateHandler._Date_cs.DateParserCZ +.. autoclass:: gen.datehandler._date_cs.DateParserCZ :members: :undoc-members: :show-inheritance: -.. autoclass:: DateHandler._Date_cs.DateDisplayCZ +.. autoclass:: gen.datehandler._date_cs.DateDisplayCZ :members: :undoc-members: :show-inheritance: ***************************** -DateHandler (German) +datehandler (German) ***************************** -.. autoclass:: DateHandler._Date_de.DateParserDE +.. autoclass:: gen.datehandler._date_de.DateParserDE :members: :undoc-members: :show-inheritance: -.. autoclass:: DateHandler._Date_de.DateDisplayDE +.. autoclass:: gen.datehandler._date_de.DateDisplayDE :members: :undoc-members: :show-inheritance: ***************************** -DateHandler (Spanish) +datehandler (Spanish) ***************************** -.. autoclass:: DateHandler._Date_es.DateParserES +.. autoclass:: gen.datehandler._date_es.DateParserES :members: :undoc-members: :show-inheritance: -.. autoclass:: DateHandler._Date_es.DateDisplayES +.. autoclass:: gen.datehandler._date_es.DateDisplayES :members: :undoc-members: :show-inheritance: ***************************** -DateHandler (Finnish) +datehandler (Finnish) ***************************** -.. autoclass:: DateHandler._Date_fi.DateParserFI +.. autoclass:: gen.datehandler._date_fi.DateParserFI :members: :undoc-members: :show-inheritance: -.. autoclass:: DateHandler._Date_fi.DateDisplayFI +.. autoclass:: gen.datehandler._date_fi.DateDisplayFI :members: :undoc-members: :show-inheritance: ***************************** -DateHandler (French) +datehandler (French) ***************************** -.. autoclass:: DateHandler._Date_fr.DateParserFR +.. autoclass:: gen.datehandler._date_fr.DateParserFR :members: :undoc-members: :show-inheritance: -.. autoclass:: DateHandler._Date_fr.DateDisplayFR +.. autoclass:: gen.datehandler._date_fr.DateDisplayFR :members: :undoc-members: :show-inheritance: ***************************** -DateHandler (Croatian) +datehandler (Croatian) ***************************** -.. autoclass:: DateHandler._Date_hr.DateParserHR +.. autoclass:: gen.datehandler._date_hr.DateParserHR :members: :undoc-members: :show-inheritance: -.. autoclass:: DateHandler._Date_hr.DateDisplayHR +.. autoclass:: gen.datehandler._date_hr.DateDisplayHR :members: :undoc-members: :show-inheritance: ***************************** -DateHandler (Italian) +datehandler (Italian) ***************************** -.. autoclass:: DateHandler._Date_it.DateParserIT +.. autoclass:: gen.datehandler._date_it.DateParserIT :members: :undoc-members: :show-inheritance: -.. autoclass:: DateHandler._Date_it.DateDisplayIT +.. autoclass:: gen.datehandler._date_it.DateDisplayIT :members: :undoc-members: :show-inheritance: ***************************** -DateHandler (Lituanian) +datehandler (Lituanian) ***************************** -.. autoclass:: DateHandler._Date_lt.DateParserLT +.. autoclass:: gen.datehandler._date_lt.DateParserLT :members: :undoc-members: :show-inheritance: -.. autoclass:: DateHandler._Date_lt.DateDisplayLT +.. autoclass:: gen.datehandler._date_lt.DateDisplayLT :members: :undoc-members: :show-inheritance: ***************************** -DateHandler (Norwegian) +datehandler (Norwegian) ***************************** -.. autoclass:: DateHandler._Date_nb.DateParserNb +.. autoclass:: gen.datehandler._date_nb.DateParserNb :members: :undoc-members: :show-inheritance: -.. autoclass:: DateHandler._Date_nb.DateDisplayNb +.. autoclass:: gen.datehandler._date_nb.DateDisplayNb :members: :undoc-members: :show-inheritance: ***************************** -DateHandler (Dutch) +datehandler (Dutch) ***************************** -.. autoclass:: DateHandler._Date_nl.DateParserNL +.. autoclass:: gen.datehandler._date_nl.DateParserNL :members: :undoc-members: :show-inheritance: -.. autoclass:: DateHandler._Date_nl.DateDisplayNL +.. autoclass:: gen.datehandler._date_nl.DateDisplayNL :members: :undoc-members: :show-inheritance: ***************************** -DateHandler (Polish) +datehandler (Polish) ***************************** -.. autoclass:: DateHandler._Date_pl.DateParserPL +.. autoclass:: gen.datehandler._date_pl.DateParserPL :members: :undoc-members: :show-inheritance: -.. autoclass:: DateHandler._Date_pl.DateDisplayPL +.. autoclass:: gen.datehandler._date_pl.DateDisplayPL :members: :undoc-members: :show-inheritance: ***************************** -DateHandler (Portuguese) +datehandler (Portuguese) ***************************** -.. autoclass:: DateHandler._Date_pt.DateParserPT +.. autoclass:: gen.datehandler._date_pt.DateParserPT :members: :undoc-members: :show-inheritance: -.. autoclass:: DateHandler._Date_pt.DateDisplayPT +.. autoclass:: gen.datehandler._date_pt.DateDisplayPT :members: :undoc-members: :show-inheritance: ***************************** -DateHandler (Russian) +datehandler (Russian) ***************************** -.. autoclass:: DateHandler._Date_ru.DateParserRU +.. autoclass:: gen.datehandler._date_ru.DateParserRU :members: :undoc-members: :show-inheritance: -.. autoclass:: DateHandler._Date_ru.DateDisplayRU +.. autoclass:: gen.datehandler._date_ru.DateDisplayRU :members: :undoc-members: :show-inheritance: ***************************** -DateHandler (Slovak) +datehandler (Slovak) ***************************** -.. autoclass:: DateHandler._Date_sk.DateParserSK +.. autoclass:: gen.datehandler._date_sk.DateParserSK :members: :undoc-members: :show-inheritance: -.. autoclass:: DateHandler._Date_sk.DateDisplaySK +.. autoclass:: gen.datehandler._date_sk.DateDisplaySK :members: :undoc-members: :show-inheritance: ***************************** -DateHandler (Slovenian) +datehandler (Slovenian) ***************************** -.. autoclass:: DateHandler._Date_sl.DateParserSL +.. autoclass:: gen.datehandler._date_sl.DateParserSL :members: :undoc-members: :show-inheritance: -.. autoclass:: DateHandler._Date_sl.DateDisplaySL +.. autoclass:: gen.datehandler._date_sl.DateDisplaySL :members: :undoc-members: :show-inheritance: ***************************** -DateHandler (Serbian) +datehandler (Serbian) ***************************** -.. autoclass:: DateHandler._Date_sr.DateParserSR +.. autoclass:: gen.datehandler._date_sr.DateParserSR :members: :undoc-members: :show-inheritance: -.. autoclass:: DateHandler._Date_sr.DateDisplaySR_latin +.. autoclass:: gen.datehandler._date_sr.DateDisplaySR_latin :members: :undoc-members: :show-inheritance: ***************************** -DateHandler (Swedish) +datehandler (Swedish) ***************************** -.. autoclass:: DateHandler._Date_sv.DateParserSv +.. autoclass:: gen.datehandler._date_sv.DateParserSv :members: :undoc-members: :show-inheritance: -.. autoclass:: DateHandler._Date_sv.DateDisplaySv +.. autoclass:: gen.datehandler._date_sv.DateDisplaySv :members: :undoc-members: :show-inheritance: @@ -273,7 +273,7 @@ The :class:`Date Edition` Classes DateEdit ==================================== -.. automodule:: DateEdit +.. automodule:: gui.editors.editdate :members: :undoc-members: :show-inheritance: diff --git a/docs/gen/gen.rst b/docs/gen/gen.rst index c5b7c9840..e0d4228ed 100644 --- a/docs/gen/gen.rst +++ b/docs/gen/gen.rst @@ -4,6 +4,60 @@ The :mod:`gen` Module .. automodule:: gen +***************************** +Database State +***************************** +.. automodule:: gen.dbstate +.. autoclass:: DbState + :members: + :undoc-members: + :show-inheritance: + +***************************** +Errors +***************************** +.. automodule:: gen.errors +.. autoclass:: DatabaseError + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: DateError + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: DbError + :members: + :undoc-members: + :show-inheritance: + +TODO + +***************************** +Recent Files +***************************** +.. automodule:: gen.recentfiles +.. autoclass:: RecentFiles + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: RecentItem + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: RecentParser + :members: + :undoc-members: + :show-inheritance: + +***************************** +Sort +***************************** +.. automodule:: gen.sort +.. autoclass:: Sort + :members: + :undoc-members: + :show-inheritance: + ***************************** Update callback ***************************** diff --git a/docs/gen/gen_proxy.rst b/docs/gen/gen_proxy.rst index facbde894..790f46228 100644 --- a/docs/gen/gen_proxy.rst +++ b/docs/gen/gen_proxy.rst @@ -34,10 +34,6 @@ Private References ==================================== -.. automodule:: gen.proxy.referenced - :members: - :undoc-members: - :show-inheritance: .. automodule:: gen.proxy.referencedbyselection :members: :undoc-members: diff --git a/docs/gen/gen_utils.rst b/docs/gen/gen_utils.rst index b641de96d..8fe624e22 100644 --- a/docs/gen/gen_utils.rst +++ b/docs/gen/gen_utils.rst @@ -14,11 +14,59 @@ Utils :members: :undoc-members: :show-inheritance: +.. automodule:: gen.utils.cast + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.utils.config + :members: + :undoc-members: + :show-inheritance: .. automodule:: gen.utils.configmanager :members: :undoc-members: :show-inheritance: -.. automodule:: gen.utils.fallback +.. automodule:: gen.utils.db + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.utils.file + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.utils.id + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.utils.image + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.utils.keyword + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.utils.lds + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.utils.mactrans + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.utils.place + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.utils.string + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.utils.trans + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.utils.unknown :members: :undoc-members: :show-inheritance: diff --git a/docs/relationship.rst b/docs/relationship.rst index d82633bf0..0d99946f1 100644 --- a/docs/relationship.rst +++ b/docs/relationship.rst @@ -2,7 +2,7 @@ The :class:`RelationshipCalculator` Class ######################################### -.. automodule:: Relationship +.. automodule:: gen.relationship .. autoclass:: RelationshipCalculator :members: :undoc-members: diff --git a/docs/simple.rst b/docs/simple.rst index e25b18ba7..e2dc12af2 100644 --- a/docs/simple.rst +++ b/docs/simple.rst @@ -2,25 +2,25 @@ The :class:`Simple` Classes ########################### -.. automodule:: Simple +.. automodule:: gen.simple Simple Access ==================================== -.. automodule:: Simple._SimpleAccess +.. automodule:: gen.simple._simpleaccess :members: :undoc-members: :show-inheritance: Simple Doc ==================================== -.. automodule:: Simple._SimpleDoc +.. automodule:: gen.simple._simpledoc :members: :undoc-members: :show-inheritance: Simple Table ==================================== -.. automodule:: Simple._SimpleTable +.. automodule:: gen.simple._simpletable :members: :undoc-members: :show-inheritance: diff --git a/docs/utils.rst b/docs/utils.rst deleted file mode 100644 index ec83fbece..000000000 --- a/docs/utils.rst +++ /dev/null @@ -1,12 +0,0 @@ -############################ -The :mod:`Utils` Module -############################ - -Contents: - -.. automodule:: Utils - :members: - :undoc-members: - :show-inheritance: - -