Author: locilka
Date: Tue Jul 15 17:33:13 2008
New Revision: 49111
URL: http://svn.opensuse.org/viewcvs/yast?rev=49111&view=rev
Log:
- Fixed ycpdoc warnings for SuSEFirewall (added/fixed docu.)
Modified:
trunk/yast2/library/network/src/SuSEFirewall.ycp
trunk/yast2/package/yast2.changes
Modified: trunk/yast2/library/network/src/SuSEFirewall.ycp
URL: http://svn.opensuse.org/viewcvs/yast/trunk/yast2/library/network/src/SuSEFirewall.ycp?rev=49111&r1=49110&r2=49111&view=diff
==============================================================================
--- trunk/yast2/library/network/src/SuSEFirewall.ycp (original)
+++ trunk/yast2/library/network/src/SuSEFirewall.ycp Tue Jul 15 17:33:13 2008
@@ -165,8 +165,10 @@
modified = true;
}
- // Please, do not us this function
- // Only for firewall installation proposal
+ /**
+ * Do not us this function.
+ * Only for firewall installation proposal
+ */
global define void ResetModified () {
y2milestone("Reseting firewall-modified to 'false'");
modified = false;
@@ -255,6 +257,8 @@
/**
* Local function returns if other functions should produce verbose output.
* like popups, reporting errors, etc.
+ *
+ * @return boolean is_verbose
*/
boolean IsVerbose () {
// verbose level must be above zero to be verbose
@@ -265,6 +269,7 @@
* Local function for returning default values (if defined) for sysconfig variables.
*
* @param string sysconfig variable
+ * @return string default value
*/
string GetDefaultValue (string variable) {
return (string) DEFAULT_SETTINGS[variable]:"";
@@ -313,6 +318,7 @@
* into the disk, use `nil` as the last list item.
*
* @param list <string> of sysconfig variables
+ * @return boolean if successful
*/
boolean WriteSysconfigSuSEFirewall (list<string> variables) {
boolean write_status = true;
@@ -452,7 +458,7 @@
* it doesn't return ports that are listed in some service (defined by package)
* which is enabled.
*
- * @return map strings are allowed ports or port ranges
+ * @return map strings are allowed ports or port ranges
*
* @struct $[
* "ZONE1" : [ "port1", "port2" ],
@@ -1499,6 +1505,7 @@
* @struct [ $[ "id":"modem0", "name":"Askey 815C", "type":"dialup", "zone":"EXT" ], ... ]
*
* @return list