ref: refs/heads/master
commit 153b31627dd0176d7080beeec03da8cc9d8e4b81
Author: Josef Reidinger
Date: Tue Aug 4 13:26:26 2009 +0200
document language model
---
plugins/language/app/models/language.rb | 18 ++++++++++++++++--
1 files changed, 16 insertions(+), 2 deletions(-)
diff --git a/plugins/language/app/models/language.rb b/plugins/language/app/models/language.rb
index ab90259..ae2df79 100644
--- a/plugins/language/app/models/language.rb
+++ b/plugins/language/app/models/language.rb
@@ -1,4 +1,9 @@
-class Language
+# = Language model
+# Provides set and gets resources from YaPI time module.
+# Main goal is handle YaPI specific calls and data formats. Provide cleaned
+# and well defined data.
+class Language
+ # cache available languages as it is change only rarely
@@available = {}
attr_accessor :language,
:utf8,
@@ -13,6 +18,8 @@ class Language
# dbus parsers
#
+ # Parses response from dbus YaPI call
+ # response:: response from dbus
def parse_response(response)
@language = response["current"]
@utf8 = response["utf8"]
@@ -22,6 +29,9 @@ class Language
end
end
+ # Creates argument for dbus call which specify what data is requested.
+ # Available languages is cached so request it only if it is necessary.
+ # return:: hash with requested keys
def create_read_question
ret = {
"current" => "true",
@@ -40,14 +50,18 @@ class Language
#
public
- def available
+ # Getter for available static field
+ def Language.available
return @@available
end
+ # fills language instance with data from YaPI.
+ # +warn+: Doesn't take any parameters and is not static.
def find
parse_response YastService.Call("YaPI::LANGUAGE::Read",create_read_question)
end
+ # Saves data from model to system via YaPI
def save
settings = {
"current" => @language,
--
To unsubscribe, e-mail: yast-commit+unsubscribe@opensuse.org
For additional commands, e-mail: yast-commit+help@opensuse.org
