Salome HOME
Fix some documentation issues
authorOvidiu Mircescu <ovidiu.mircescu@edf.fr>
Fri, 5 Sep 2014 13:45:25 +0000 (15:45 +0200)
committerOvidiu Mircescu <ovidiu.mircescu@edf.fr>
Fri, 5 Sep 2014 13:45:25 +0000 (15:45 +0200)
module_generator/cppcompo.py
module_generator/fcompo.py

index e4934c8b5685cc982189cd8fd702110c1ac8170f..4cc268d1c0ca2f971f599d436b08a6c7eeab6a3b 100644 (file)
@@ -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.
index be302941d5beb28ea2c1224bd281834bf9a95fab..4c2cb604d26f5f6c502b624118df82603e3fea0d 100644 (file)
@@ -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.