diff options
author | Amar Takhar <amar@rtems.org> | 2015-06-12 10:32:08 -0400 |
---|---|---|
committer | Amar Takhar <amar@rtems.org> | 2015-12-11 15:16:24 -0500 |
commit | 0ff2e193200824d148bbcdf395726bb7941bbff6 (patch) | |
tree | 529cb3089d48e0dbf1b7f8aceb0d7f45ff2a3b32 | |
parent | ef9430a00409502489825c7b67a09a9a5fb5cd55 (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 = {} |