瀏覽代碼

Add doc to ctkDICOMImportWidget

Julien Finet 13 年之前
父節點
當前提交
dffe3aa303
共有 2 個文件被更改,包括 7 次插入4 次删除
  1. 0 1
      Libs/DICOM/Widgets/ctkDICOMAppWidget.cpp
  2. 7 3
      Libs/DICOM/Widgets/ctkDICOMImportWidget.h

+ 0 - 1
Libs/DICOM/Widgets/ctkDICOMAppWidget.cpp

@@ -48,7 +48,6 @@
 
 // ctkDICOMWidgets includes
 #include "ctkDICOMAppWidget.h"
-#include "ctkDICOMImportWidget.h"
 #include "ctkDICOMThumbnailGenerator.h"
 #include "ctkThumbnailLabel.h"
 #include "ctkDICOMQueryResultsTabWidget.h"

+ 7 - 3
Libs/DICOM/Widgets/ctkDICOMImportWidget.h

@@ -24,13 +24,17 @@
 // Qt includes 
 #include <QWidget>
 
+// CTK includes
 #include "ctkDICOMWidgetsExport.h"
-
-class ctkDICOMImportWidgetPrivate;
-
 class ctkDICOMDatabase;
+class ctkDICOMImportWidgetPrivate;
 
 /// \ingroup DICOM_Widgets
+/// Panel to select a directory containing DICOM files on a local file system.
+/// It contains 3 elements: directory selection, listing of directory files and
+/// options to apply when importing.
+/// \todo the passed DICOM database is not used.
+/// \todo expose topDirectory, copyToLibrary... in public API
 class CTK_DICOM_WIDGETS_EXPORT ctkDICOMImportWidget : public QWidget
 {
   Q_OBJECT