From c0f80cbbeec176f303d3ef1b7ab94582c018fcd8 Mon Sep 17 00:00:00 2001 From: Mats Wichmann Date: Thu, 20 Oct 2022 09:10:31 -0600 Subject: Add Java scanner to generated API docs Signed-off-by: Mats Wichmann --- SCons/Scanner/Java.py | 14 ++++++++------ doc/sphinx/SCons.Scanner.rst | 8 ++++++++ 2 files changed, 16 insertions(+), 6 deletions(-) diff --git a/SCons/Scanner/Java.py b/SCons/Scanner/Java.py index f6edf93..8c31bc1 100644 --- a/SCons/Scanner/Java.py +++ b/SCons/Scanner/Java.py @@ -32,12 +32,14 @@ from SCons.Util import flatten, is_String def _subst_paths(env, paths) -> list: """Return a list of substituted path elements. - If *paths* is a string, it is split on the search-path separator - (this makes the interpretation system-specific - this is warned about - in the manpage). This helps support behavior like pulling in the - external ``CLASSPATH`` and setting it directly into ``JAVACLASSPATH``. - Otherwise, substitution is done on string-valued list elements - but not splitting. + If *paths* is a string, it is split on the search-path separator. + Otherwise, substitution is done on string-valued list elements but + they are not split. + + Note helps support behavior like pulling in the external ``CLASSPATH`` + and setting it directly into ``JAVACLASSPATH``, however splitting on + ``os.pathsep`` makes the interpretation system-specific (this is + warned about in the manpage entry for ``JAVACLASSPATH``). """ if is_String(paths): paths = env.subst(paths) diff --git a/doc/sphinx/SCons.Scanner.rst b/doc/sphinx/SCons.Scanner.rst index 181dbde..484bd43 100644 --- a/doc/sphinx/SCons.Scanner.rst +++ b/doc/sphinx/SCons.Scanner.rst @@ -44,6 +44,14 @@ SCons.Scanner.IDL module :undoc-members: :show-inheritance: +SCons.Scanner.Java module +------------------------- + +.. automodule:: SCons.Scanner.Java + :members: + :undoc-members: + :show-inheritance: + SCons.Scanner.LaTeX module -------------------------- -- cgit v0.12