document css files better
authorsheepluva
Sat, 22 Oct 2011 18:24:36 +0200
changeset 6185 a6aa2d44f390
parent 6184 335ece2bce9c
child 6186 255aff92216d
document css files better
QTfrontend/Doxyfile
QTfrontend/HWApplication.h
QTfrontend/res/css/chat.css
QTfrontend/res/css/qt.css
QTfrontend/ui/widget/chatwidget.h
--- a/QTfrontend/Doxyfile	Sat Oct 22 11:50:55 2011 -0400
+++ b/QTfrontend/Doxyfile	Sat Oct 22 18:24:36 2011 +0200
@@ -190,7 +190,7 @@
 # will result in a user-defined paragraph with heading "Side Effects:".
 # You can put \n's in the value part of an alias to insert newlines.
 
-ALIASES                =
+ALIASES                = "repo{1}=http://code.google.com/p/hedgewars/source/browse/QTfrontend/\1"
 
 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
 # sources only. Doxygen will then generate output that is more tailored for C.
@@ -319,7 +319,7 @@
 # If the EXTRACT_STATIC tag is set to YES all static members of a file
 # will be included in the documentation.
 
-EXTRACT_STATIC         = NO
+EXTRACT_STATIC         = YES
 
 # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
 # defined locally in source files will be included in the documentation.
--- a/QTfrontend/HWApplication.h	Sat Oct 22 11:50:55 2011 -0400
+++ b/QTfrontend/HWApplication.h	Sat Oct 22 18:24:36 2011 +0200
@@ -25,6 +25,14 @@
 
 class HWForm;
 
+/**
+ * @brief Main class of the Qt application.
+ *
+ * By default uses :res/css/qt.css as style sheet for the main form.
+ * See \repo{res/css/qt.css} for a more detailed description.
+ *
+ * @see http://doc.qt.nokia.com/4.5/stylesheet.html
+ */
 class HWApplication : public QApplication
 {
     Q_OBJECT
--- a/QTfrontend/res/css/chat.css	Sat Oct 22 11:50:55 2011 -0400
+++ b/QTfrontend/res/css/chat.css	Sat Oct 22 18:24:36 2011 +0200
@@ -1,10 +1,25 @@
-/*
+/******************************************************************************
+ *
+ * CSS-like definition of chat appearance
+ *
+ ******************************************************************************
+ *
  * see http://doc.qt.nokia.com/4.5/richtext-html-subset.html#css-properties
  *
  * In the QTfrontend of hedgewars also display:none; will work for class names
  * that start with msg_   -   as long as they are referenced directly and not
  * within any hierachy.
- */
+ *
+ ******************************************************************************
+ *
+ * This file can be stored at different locations, but it will be read only
+ * once, based on first file found in this order:
+ *
+ *     <userdir>/Data/css/chat.css
+ *     <datadir>/css/chat.css
+ *     <internal default style-sheet>
+ *
+ *****************************************************************************/
 
 /* links */
 a { color:#c8c8ff; }
--- a/QTfrontend/res/css/qt.css	Sat Oct 22 11:50:55 2011 -0400
+++ b/QTfrontend/res/css/qt.css	Sat Oct 22 18:24:36 2011 +0200
@@ -1,3 +1,22 @@
+/******************************************************************************
+ *
+ * CSS-like definition of Qt frontend appearance
+ *
+ ******************************************************************************
+ *
+ * see http://doc.qt.nokia.com/4.5/stylesheet.html
+ *
+ ******************************************************************************
+ *
+ * This file can be stored at different locations, but it will be read only
+ * once, based on first file found in this order:
+ *
+ *     <userdir>/Data/css/qt.css
+ *     <datadir>/css/qt.css
+ *     <internal default style-sheet> (:/res/css/qt.css)
+ *
+ *****************************************************************************/
+
 HWForm,QDialog {
 background-image: url(":/res/Background.png");
 background-position: bottom center;
@@ -223,4 +242,5 @@
 border-radius: 3px;
 background-color: #ffcc00;
 width: 8px;
-}
\ No newline at end of file
+}
+
--- a/QTfrontend/ui/widget/chatwidget.h	Sat Oct 22 11:50:55 2011 -0400
+++ b/QTfrontend/ui/widget/chatwidget.h	Sat Oct 22 18:24:36 2011 +0200
@@ -52,6 +52,16 @@
   bool isIgnored;
 };
 
+
+/**
+ * @brief A chat widget.
+ *
+ * By default uses :res/css/chat.css as style sheet for chat.
+ * See \repo{res/css/chat.css} for a more detailed description.
+ *
+ * @see http://doc.qt.nokia.com/4.5/richtext-html-subset.html#css-properties
+ */
+
 class HWChatWidget : public QWidget
 {
   Q_OBJECT