ASDoc: how to include all classes (and only those classes) in a package without manually specifying them?

299 views Asked by At

The task is simple, I need to document a dozen of ActionScript / Flex classes in a certain package and there are "only" two requirements:

  1. Only those classes should be documented, no classes from other packages.
  2. I don't want to manually enumerate all the classes, that creates a maintenance burden (need to update the ASDoc script whenever new classes are added or removed from the package).

-doc-sources will allow me to specify a path to a package directory which is good for the second point but will make the first point hard to achieve as -exclude-dependencies option throws an error when -doc-sources method is used.

The other way to specify which classes to document is -source-path + -doc-classes but -doc-classes doesn't support wildcards so I don't think I can throw a package on it.

The third way is to use -doc-namespaces but that expects an XML file with all the classes enumerated manually so that doesn't help either.

Is there a way to achieve my "simple" task with the current implementation of ASDoc?

1

There are 1 answers

2
Ilya Gazman On