Browse Source

WIP: Add comments

Lipu Fei 6 years ago
parent
commit
53ea944da1

+ 5 - 0
resources/qml/WelcomePages/AddNetworkPrinterScrollView.qml

@@ -10,6 +10,11 @@ import Cura 1.1 as Cura
 import "../PrinterSelector"
 
 
+//
+// This is the widget for adding a network printer. There are 2 parts in this widget. One is a scroll view of a list
+// of discovered network printers. Beneath the scroll view is a container with 3 buttons: "Refresh", "Add by IP", and
+// "Troubleshooting".
+//
 Item
 {
     id: base

+ 4 - 0
resources/qml/WelcomePages/AddPrinterScrollView.qml

@@ -8,6 +8,10 @@ import UM 1.3 as UM
 import Cura 1.0 as Cura
 
 
+//
+// This is the scroll view widget for adding a (local) printer. This scroll view shows a list view with printers
+// categorized into 3 categories: "Ultimaker", "Custom", and "Other".
+//
 ScrollView
 {
     id: base

+ 1 - 1
resources/qml/WelcomePages/DropDownHeader.qml

@@ -11,7 +11,7 @@ import ".."
 
 
 //
-// This is DropDown Header bar of the expandable drop down list.
+// This is DropDown Header bar of the expandable drop down list. See comments in DropDownWidget for details.
 //
 Cura.RoundedRectangle
 {

+ 7 - 0
resources/qml/WelcomePages/DropDownWidget.qml

@@ -8,6 +8,13 @@ import UM 1.3 as UM
 import Cura 1.1 as Cura
 
 
+//
+// This is the dropdown list widget in the welcome wizard. The dropdown list has a header bar which is always present,
+// and its content whose visibility can be toggled by clicking on the header bar. The content is displayed as an
+// expandable dropdown box that will appear below the header bar.
+//
+// The content is configurable via the property "contentComponent", which will be loaded by a Loader when set.
+//
 Item
 {
     UM.I18nCatalog { id: catalog; name: "cura" }