From 91a1694ceb23ba9051844c52fd67653bc000f0a7 Mon Sep 17 00:00:00 2001 From: Ovidiu Mircescu Date: Fri, 5 Sep 2014 15:45:25 +0200 Subject: [PATCH] Fix some documentation issues --- module_generator/cppcompo.py | 6 +++--- module_generator/fcompo.py | 7 +++++-- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/module_generator/cppcompo.py b/module_generator/cppcompo.py index e4934c8..4cc268d 100644 --- a/module_generator/cppcompo.py +++ b/module_generator/cppcompo.py @@ -42,11 +42,11 @@ class CPPComponent(Component): :param services: the list of services (:class:`Service`) of the component. :param kind: If it is given and has the value "exe", the component will be built as a standalone component (executable or shell script). The default is to build the component as a dynamic library. - :param libs: list of the additional libraries. see :class:'Library' + :param libs: list of the additional libraries. see *Library* class. If you want to add "libmylib.so", installed in "/path/to/lib" you should use: - libs=[Library(name="mylib", path="/path/to/lib"] + libs=[Library(name="mylib", path="/path/to/lib")] For more advanced features, see the documentation of cmake / FIND_LIBRARY - :param rlibs: semicolon-separated list specifying the rpath to use in installed targets + :param rlibs: space-separated list specifying the rpath to use in installed targets :param includes: additional include directories, separated by spaces. :param sources: gives all the external source files to add in the compilation step (list of paths). :param exe_path: is only used when kind is "exe" and gives the path to the standalone component. diff --git a/module_generator/fcompo.py b/module_generator/fcompo.py index be30294..4c2cb60 100644 --- a/module_generator/fcompo.py +++ b/module_generator/fcompo.py @@ -38,8 +38,11 @@ class F77Component(CPPComponent): :param services: the list of services (:class:`Service`) of the component. :param kind: If it is given and has the value "exe", the component will be built as a standalone component (executable or shell script). The default is to build the component as a dynamic library. - :param libs: gives all the libraries options to add when linking the generated component (-L...). - :param rlibs: gives all the runtime libraries options to add when linking the generated component (-R...). + :param libs: list of the additional libraries. see *Library* class. + If you want to add "libmylib.so", installed in "/path/to/lib" you should use: + libs=[Library(name="mylib", path="/path/to/lib")] + For more advanced features, see the documentation of cmake / FIND_LIBRARY + :param rlibs: space-separated list specifying the rpath to use in installed targets :param sources: gives all the external source files to add in the compilation step (list of paths). :param exe_path: is only used when kind is "exe" and gives the path to the standalone component. -- 2.39.2