Skip to content
This repository has been archived by the owner on Oct 13, 2023. It is now read-only.

No public or protected classes found to document. #40

Open
tlinkowski opened this issue Aug 19, 2019 · 4 comments
Open

No public or protected classes found to document. #40

tlinkowski opened this issue Aug 19, 2019 · 4 comments
Assignees
Labels
bug Something isn't working

Comments

@tlinkowski
Copy link
Owner

Occurs for all unij-bundle-* projects and empty unij-collect-* and unij-misc-* projects.

We probably just need to disable javadoc until the project contents are filled.

@tlinkowski tlinkowski added the bug Something isn't working label Aug 19, 2019
@tlinkowski tlinkowski added this to the 0.1.0 milestone Aug 19, 2019
@tlinkowski tlinkowski self-assigned this Aug 19, 2019
@tlinkowski
Copy link
Owner Author

This still occurs for unij-bundle-* projects if we try to enable javadoc, even after #42 has been fixed.

@tlinkowski tlinkowski reopened this Aug 21, 2019
@tlinkowski
Copy link
Owner Author

Wonder how it works for JDK's java.se module, which also has no public or protected classes to document, and yet it's Javadoc gets generated:

Source:

The one potential workaround I found: https://stackoverflow.com/questions/1138390/javadoc-for-package-info-java-only (it'd require adding a dummy temporary file to javadoc sources - the original issue is about package-info, so I'm not sure it'd work here).

tlinkowski added a commit that referenced this issue Sep 2, 2019
@tlinkowski tlinkowski removed this from the 0.1.0 milestone Sep 2, 2019
@tlinkowski
Copy link
Owner Author

This is a bigger problem - even other modules for which the JavaDoc is generated don't have proper info about modules they require, etc.

The main problem here is this - modules are not specified as targets to be documented at all (there is no module summary in any of the modules).

I tried playing with --module, --module-source-path, and -Xmodule: options, but to no avail so far. It must be possible to do this in such a way that JavaDoc understands there are other modules and documents/links to them.

When it works, @moduleGraph option should probably work too (currently, it has no effect).

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant