Author: locilka Date: Tue Jul 15 18:32:01 2008 New Revision: 49127 URL: http://svn.opensuse.org/viewcvs/yast?rev=49127&view=rev Log: Fixed ycpdoc warnings for SuSEFirewall*.ycp (added/fixed docu.) (the real changes) Modified: trunk/yast2/library/network/src/SuSEFirewallProposal.ycp trunk/yast2/library/network/src/SuSEFirewallServices.ycp Modified: trunk/yast2/library/network/src/SuSEFirewallProposal.ycp URL: http://svn.opensuse.org/viewcvs/yast/trunk/yast2/library/network/src/SuSEFirewallProposal.ycp?rev=49127&r1=49126&r2=49127&view=diff ============================================================================== --- trunk/yast2/library/network/src/SuSEFirewallProposal.ycp (original) +++ trunk/yast2/library/network/src/SuSEFirewallProposal.ycp Tue Jul 15 18:32:01 2008 @@ -55,7 +55,7 @@ /** * Function returns list of warnings for user * - * @return list [string] of warnings + * @return list <string> of warnings */ list <string> GetWarnings () { return warnings_now; @@ -64,7 +64,7 @@ /** * Local function sets currently known interfaces. * - * @param list [string] of known interfaces + * @param list <string> of known interfaces */ void SetKnownInterfaces(list <string> interfaces) { known_interfaces = interfaces; @@ -153,6 +153,13 @@ SetKnownInterfaces(currently_known_interfaces); } + /** + * Returns whether service is enabled in zones. + * + * @param string service + * @param list <string> zones + * @return boolean if enabled + */ boolean ServiceEnabled (string service, list <string> zones) { if (service == nil || service == "") { y2error ("Ups, service: %1?", service); @@ -178,6 +185,12 @@ return serenabled; } + /** + * Enables ports in zones. + * + * @param list <string> fallback_ports + * @param list <string> zones + */ void EnableFallbackPorts (list <string> fallback_ports, list <string> zones) { y2warning ("Enabling fallback ports: %1 in zones: %2", fallback_ports, zones); @@ -239,6 +252,8 @@ /** * Local function returns whether the Xen kernel is installed + * + * @return boolean whether xen-capable kernel is installed. */ boolean IsXenInstalled () { // bug #154133 Modified: trunk/yast2/library/network/src/SuSEFirewallServices.ycp URL: http://svn.opensuse.org/viewcvs/yast/trunk/yast2/library/network/src/SuSEFirewallServices.ycp?rev=49127&r1=49126&r2=49127&view=diff ============================================================================== --- trunk/yast2/library/network/src/SuSEFirewallServices.ycp (original) +++ trunk/yast2/library/network/src/SuSEFirewallServices.ycp Tue Jul 15 18:32:01 2008 @@ -238,6 +238,10 @@ /** * Returns whether the service ID is defined by package. + * Returns 'false' if it isn't. + * + * @param string service + * @return boolean whether service is defined by package * * @example * ServiceDefinedByPackage ("http-server") -> false @@ -270,6 +274,12 @@ return ret; } + /** + * Returns SCR Agent definition. + * + * @return term with agent definition + * @param string full filename path (to read by this agent) + */ term GetMetadataAgent (string filefullpath) { return `IniAgent(filefullpath, $[ @@ -293,6 +303,8 @@ /** * Reads definition of services that can be used in FW_CONFIGURATIONS_[EXT|INT|DMZ] * in SuSEfirewall2. + * + * @return boolean if successful */ global define boolean ReadServicesDefinedByRPMPackages () { if (! FileUtils::Exists (services_definitions_in) || ! FileUtils::IsDirectory (services_definitions_in)) { @@ -381,8 +393,10 @@ /** * Function returns the map of supported (known) services. * - * @return map $[service_id : localized_service_name] + * @return map + * * @struct + * $[ service_id : localized_service_name ] * $[ * "dns-server" : "DNS Server", * "vnc" : "Remote Administration", @@ -419,7 +433,7 @@ * Function returns needed TCP ports for service * * @param string service - * @return list [string] of needed TCP ports + * @return list <string> of needed TCP ports */ global define list <string> GetNeededTCPPorts (string service) { return SERVICES[service,"tcp_ports"]:[]; @@ -429,7 +443,7 @@ * Function returns needed UDP ports for service * * @param string service - * @return list [string] of needed UDP ports + * @return list <string> of needed UDP ports */ global define list <string> GetNeededUDPPorts (string service) { return SERVICES[service,"udp_ports"]:[]; @@ -439,7 +453,7 @@ * Function returns needed RPC ports for service * * @param string service - * @return list [string] of needed RPC ports + * @return list <string> of needed RPC ports */ global define list <string> GetNeededRPCPorts (string service) { return SERVICES[service,"rpc_ports"]:[]; @@ -449,7 +463,7 @@ * Function returns needed IP protocols for service * * @param string service - * @return list [string] of needed IP protocols + * @return list <string> of needed IP protocols */ global define list <string> GetNeededIPProtocols (string service) { return SERVICES[service,"ip_protocols"]:[]; @@ -482,7 +496,7 @@ * Function returns needed ports allowing broadcast * * @param string service - * @return list [string] of needed broadcast ports + * @return list <string> of needed broadcast ports */ global define list <string> GetNeededBroadcastPorts (string service) { return SERVICES[service,"broadcast_ports"]:[]; -- To unsubscribe, e-mail: yast-commit+unsubscribe@opensuse.org For additional commands, e-mail: yast-commit+help@opensuse.org