Minor documentation update, and add header to .pro file

johnhk · Jan 26, 2012 · 439a569 · 439a569
1 parent 7e74567
commit 439a569
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 1 deletion.
diff --git a/StructEnumDefinition.h b/StructEnumDefinition.h
@@ -82,13 +82,15 @@ enum SizeUnit
 	SizeUnit_YottaByte
 };
 
+/// \brief structure for decompossed time
 struct TimeDecomposition
 {
 	quint16 second;
 	quint16 minute;
 	quint16 hour;
 };
 
+/// \brief item to insert item in the interface
 struct ItemOfCopyList
 {
 	quint64 id;
@@ -100,12 +102,14 @@ struct ItemOfCopyList
 	CopyMode mode;
 };
 
+/// \brief The definition of no removing action on transfer list
 struct ActionOnCopyList
 {
 	ActionTypeCopyList type;
 	quint64 id;
 };
 
+/// \brief action normal or due to interface query on copy list
 struct returnActionOnCopyList
 {
 	ReturnActionTypeCopyList type;///< is OtherAction or AddingItem
@@ -117,6 +121,7 @@ struct returnActionOnCopyList
 	ItemOfCopyList addAction;
 };
 
+/// \brief to return file progression of previousled asked query
 struct returnSpecificFileProgression
 {
 	quint64 copiedSize;

diff --git a/StructEnumDefinition_UltracopierSpecific.h b/StructEnumDefinition_UltracopierSpecific.h
@@ -22,6 +22,7 @@ enum PluginType
 	PluginType_Themes
 };
 
+/// \brief structure to store the general plugin related information
 struct PluginsAvailable
 {
 	PluginType category;

diff --git a/ultracopier.pro b/ultracopier.pro
@@ -77,7 +77,8 @@ HEADERS += ResourcesManager.h \
     interface/FacilityInterface.h \
     FacilityEngine.h \
     LogThread.h \
-    CompilerInfo.h
+    CompilerInfo.h \
+    StructEnumDefinition_UltracopierSpecific.h
 SOURCES += ThemesManager.cpp \
     ResourcesManager.cpp \
     main.cpp \
@@ -114,3 +115,4 @@ INCLUDEPATH += lib/qt-tar-xz/
 
 OTHER_FILES += \
     resources/resources-windows.rc
+