diff options
author | Amar Takhar <amar@rtems.org> | 2015-06-12 10:32:08 -0400 |
---|---|---|
committer | Amar Takhar <amar@rtems.org> | 2015-06-12 10:32:08 -0400 |
commit | 21f8d3ea8b4f9816be2769615717c8472262bff2 (patch) | |
tree | a0b28792b4a791cc922484c5853dc4d2c6d07c5e | |
parent | eb8fc93e30da520aa27ca9c40c4741a7a06258ed (diff) |
Add documentation.
-rw-r--r-- | py/config/__init__.py | 16 |
1 files changed, 15 insertions, 1 deletions
diff --git a/py/config/__init__.py b/py/config/__init__.py index ed60bd20e8..fa1ea35fdf 100644 --- a/py/config/__init__.py +++ b/py/config/__init__.py @@ -3,14 +3,28 @@ from .options import Option, Boolean, String, StringList, Integer from .tag import tag_map class RTEMSConfig(object): + """ + Main entry point for RTEMS Config + + :param dict default: Default options. + :param list config: Default configs. + + """ def __init__(self, default, config): self.default = default # Dictionary of options. self.config = config # List of configs. # self.config = feature # List of features. - # Return sorted list of options def options_get(self, category=False): + """ + Return sorted list of options + + :param list category: Categories + + :returns: List of options optionally limited by categories. + :rtype: list + """ if category: tmp = {} |