[kde-doc-english] [gcompris/devel-rebased] /: docs, reorganize documentation

Holger Kaelberer holger.k at elberer.de
Sat Mar 28 09:41:54 UTC 2015


Git commit f08fcc592aa282c5e0d2503ef35037719e345944 by Holger Kaelberer.
Committed on 24/03/2015 at 18:48.
Pushed by hkaelberer into branch 'devel-rebased'.

docs, reorganize documentation

Restrict doxygen INPUT to src/core/ and, referenced as examples,
Menu.qml and Template.qml.

kgenapidox seems to look only in docs/ for doxygen config, that we now
need to restrict INPUT.

Therefore we move everything related to documentation into docs/ and
drop doc/.

M  +4    -0    docs/Doxyfile.local
R  +-    --    docs/docbook/32px-About.png [from: doc/32px-About.png - 100% similarity]
R  +-    --    docs/docbook/32px-Button-exit.png [from: doc/32px-Button-exit.png - 100% similarity]
R  +-    --    docs/docbook/32px-Button-ok.png [from: doc/32px-Button-ok.png - 100% similarity]
R  +-    --    docs/docbook/32px-Config.png [from: doc/32px-Config.png - 100% similarity]
R  +-    --    docs/docbook/32px-Help.png [from: doc/32px-Help.png - 100% similarity]
R  +-    --    docs/docbook/32px-Home.png [from: doc/32px-Home.png - 100% similarity]
R  +-    --    docs/docbook/32px-Level1.png [from: doc/32px-Level1.png - 100% similarity]
R  +-    --    docs/docbook/32px-Repeat.png [from: doc/32px-Repeat.png - 100% similarity]
R  +-    --    docs/docbook/32px-difficulty_star1.png [from: doc/32px-difficulty_star1.png - 100% similarity]
R  +-    --    docs/docbook/32px-difficulty_star4.png [from: doc/32px-difficulty_star4.png - 100% similarity]
R  +0    -0    docs/docbook/CMakeLists.txt [from: doc/CMakeLists.txt - 100% similarity]
R  +-    --    docs/docbook/Stock_preferences_24.png [from: doc/Stock_preferences_24.png - 100% similarity]
R  +-    --    docs/docbook/admin-activity.png [from: doc/admin-activity.png - 100% similarity]
R  +-    --    docs/docbook/admin-class.png [from: doc/admin-class.png - 100% similarity]
R  +-    --    docs/docbook/admin-difficulty-filter.png [from: doc/admin-difficulty-filter.png - 100% similarity]
R  +-    --    docs/docbook/admin-group.png [from: doc/admin-group.png - 100% similarity]
R  +-    --    docs/docbook/admin-profil-edit.png [from: doc/admin-profil-edit.png - 100% similarity]
R  +-    --    docs/docbook/admin-report.png [from: doc/admin-report.png - 100% similarity]
R  +-    --    docs/docbook/gcompris-main-menu.png [from: doc/gcompris-main-menu.png - 100% similarity]
R  +0    -0    docs/docbook/index.docbook [from: doc/index.docbook - 100% similarity]
R  +-    --    docs/docbook/login-list.png [from: doc/login-list.png - 100% similarity]
R  +-    --    docs/docbook/login-text.png [from: doc/login-text.png - 100% similarity]
R  +-    --    docs/docbook/missing-letter.png [from: doc/missing-letter.png - 100% similarity]
R  +-    --    docs/docbook/reading-activity.png [from: doc/reading-activity.png - 100% similarity]
R  +0    -0    src/core/Mainpage.dox [from: docs/Mainpage.dox - 100% similarity]

http://commits.kde.org/gcompris/f08fcc592aa282c5e0d2503ef35037719e345944

diff --git a/docs/Doxyfile.local b/docs/Doxyfile.local
index 0fa7558..6a9d955 100644
--- a/docs/Doxyfile.local
+++ b/docs/Doxyfile.local
@@ -2,3 +2,7 @@ PROJECT_NAME = GCompris-qt
 DISTRIBUTE_GROUP_DOC = yes
 FILTER_PATTERNS = *.qml=doxyqml
 EXTENSION_MAPPING = qml=C++ js=C++
+#EXCLUDE_PATTERNS = */activities/*
+INPUT= src/core/ \
+       src/activities/menu/Menu.qml \
+       src/activities/template/Template.qml
diff --git a/doc/32px-About.png b/docs/docbook/32px-About.png
similarity index 100%
rename from doc/32px-About.png
rename to docs/docbook/32px-About.png
diff --git a/doc/32px-Button-exit.png b/docs/docbook/32px-Button-exit.png
similarity index 100%
rename from doc/32px-Button-exit.png
rename to docs/docbook/32px-Button-exit.png
diff --git a/doc/32px-Button-ok.png b/docs/docbook/32px-Button-ok.png
similarity index 100%
rename from doc/32px-Button-ok.png
rename to docs/docbook/32px-Button-ok.png
diff --git a/doc/32px-Config.png b/docs/docbook/32px-Config.png
similarity index 100%
rename from doc/32px-Config.png
rename to docs/docbook/32px-Config.png
diff --git a/doc/32px-Help.png b/docs/docbook/32px-Help.png
similarity index 100%
rename from doc/32px-Help.png
rename to docs/docbook/32px-Help.png
diff --git a/doc/32px-Home.png b/docs/docbook/32px-Home.png
similarity index 100%
rename from doc/32px-Home.png
rename to docs/docbook/32px-Home.png
diff --git a/doc/32px-Level1.png b/docs/docbook/32px-Level1.png
similarity index 100%
rename from doc/32px-Level1.png
rename to docs/docbook/32px-Level1.png
diff --git a/doc/32px-Repeat.png b/docs/docbook/32px-Repeat.png
similarity index 100%
rename from doc/32px-Repeat.png
rename to docs/docbook/32px-Repeat.png
diff --git a/doc/32px-difficulty_star1.png b/docs/docbook/32px-difficulty_star1.png
similarity index 100%
rename from doc/32px-difficulty_star1.png
rename to docs/docbook/32px-difficulty_star1.png
diff --git a/doc/32px-difficulty_star4.png b/docs/docbook/32px-difficulty_star4.png
similarity index 100%
rename from doc/32px-difficulty_star4.png
rename to docs/docbook/32px-difficulty_star4.png
diff --git a/doc/CMakeLists.txt b/docs/docbook/CMakeLists.txt
similarity index 100%
rename from doc/CMakeLists.txt
rename to docs/docbook/CMakeLists.txt
diff --git a/doc/Stock_preferences_24.png b/docs/docbook/Stock_preferences_24.png
similarity index 100%
rename from doc/Stock_preferences_24.png
rename to docs/docbook/Stock_preferences_24.png
diff --git a/doc/admin-activity.png b/docs/docbook/admin-activity.png
similarity index 100%
rename from doc/admin-activity.png
rename to docs/docbook/admin-activity.png
diff --git a/doc/admin-class.png b/docs/docbook/admin-class.png
similarity index 100%
rename from doc/admin-class.png
rename to docs/docbook/admin-class.png
diff --git a/doc/admin-difficulty-filter.png b/docs/docbook/admin-difficulty-filter.png
similarity index 100%
rename from doc/admin-difficulty-filter.png
rename to docs/docbook/admin-difficulty-filter.png
diff --git a/doc/admin-group.png b/docs/docbook/admin-group.png
similarity index 100%
rename from doc/admin-group.png
rename to docs/docbook/admin-group.png
diff --git a/doc/admin-profil-edit.png b/docs/docbook/admin-profil-edit.png
similarity index 100%
rename from doc/admin-profil-edit.png
rename to docs/docbook/admin-profil-edit.png
diff --git a/doc/admin-report.png b/docs/docbook/admin-report.png
similarity index 100%
rename from doc/admin-report.png
rename to docs/docbook/admin-report.png
diff --git a/doc/gcompris-main-menu.png b/docs/docbook/gcompris-main-menu.png
similarity index 100%
rename from doc/gcompris-main-menu.png
rename to docs/docbook/gcompris-main-menu.png
diff --git a/doc/index.docbook b/docs/docbook/index.docbook
similarity index 100%
rename from doc/index.docbook
rename to docs/docbook/index.docbook
diff --git a/doc/login-list.png b/docs/docbook/login-list.png
similarity index 100%
rename from doc/login-list.png
rename to docs/docbook/login-list.png
diff --git a/doc/login-text.png b/docs/docbook/login-text.png
similarity index 100%
rename from doc/login-text.png
rename to docs/docbook/login-text.png
diff --git a/doc/missing-letter.png b/docs/docbook/missing-letter.png
similarity index 100%
rename from doc/missing-letter.png
rename to docs/docbook/missing-letter.png
diff --git a/doc/reading-activity.png b/docs/docbook/reading-activity.png
similarity index 100%
rename from doc/reading-activity.png
rename to docs/docbook/reading-activity.png
diff --git a/docs/Mainpage.dox b/src/core/Mainpage.dox
similarity index 100%
rename from docs/Mainpage.dox
rename to src/core/Mainpage.dox


More information about the kde-doc-english mailing list