Fixed docs for ProductControl#getProposals,#getProposalProperties

yast · Jan 12, 2015 · 1932cd4 · 1932cd4
1 parent 56df679
commit 1932cd4
Showing 1 changed file with 8 additions and 2 deletions.
diff --git a/library/control/src/modules/ProductControl.rb b/library/control/src/modules/ProductControl.rb
@@ -1062,7 +1062,9 @@ def getMatchingProposal(stage, mode, proptype)
     # Get modules of current Workflow
     # @param [String] stage
     # @param [String] mode
-    # @return [Array<String>] modules
+    # @param [String] proptype eg. "initial", "service", network"...
+    # @return [Array<Array(String,Integer)>] modules,
+    #   pairs of ("foo_proposal", presentation_order)
     def getProposals(stage, mode, proptype)
       props = getMatchingProposal(stage, mode, proptype)
       unique_id = Ops.get_string(props, [0, "unique_id"], "")
@@ -1152,7 +1154,11 @@ def getProposalTextDomain
     end
 
 
-    # Return proposal Label
+    # @param [String] stage
+    # @param [String] mode
+    # @param [String] proptype eg. "initial", "service", network"...
+    # @return [Hash] one "proposal" element of control.rnc
+    #   where /label is not translated yet but //proposal_tab/label are.
     def getProposalProperties(stage, mode, proptype)
       got_proposals = getMatchingProposal(stage, mode, proptype)
       proposal = Ops.get(got_proposals, 0, {})