You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Summary: The public API still has significant Javadoc gaps. Only ~34% of Java files in the api/ module have class-level Javadoc, and the situation is similar in the parser/ module.
Evidence:
api/ module: 48 out of 140 Java files (~34%) have class-level Javadoc comments. 92 files are missing class-level Javadoc entirely, including key classes like Diary.java, Diarizer.java, SupportedFlags.java, and many event/summary classes.
parser/ module: 21 out of 62 Java files (~34%) have class-level Javadoc.
PR javadoc #261 (closed, not merged) attempted broader Javadoc fixes but was abandoned.
No recent commits address comprehensive Javadoc coverage for the public API.
At the method level, the gap is even wider — an estimated 65–68% of public methods across the API lack Javadoc.
Recommendation: ✅ Keep open — This issue remains valid and actionable. The Javadoc coverage of the public API is still substantially incomplete. The only merged Javadoc work (PR minimal javadoc for vertx and parser to satisfy release task #403) was a minimal effort to unblock a release, not a comprehensive documentation pass. The labels (documentation, enhancement, good first issue) are still appropriate for contributors looking to help.
Instead of trying to cover the whole public API in one large PR, I’ll start with a small set of missing class-level Javadocs in the api module, such as the key classes called out in the relevance check, and keep the PR narrowly scoped so it is easier to review.
Hi! I’m working on a focused, non-overlapping slice of this issue: completing the missing public-API Javadocs for the com.microsoft.gctoolkit.io segment and metadata contracts (LogFileSegment, LogFileMetadata, SingleLogFileMetadata, and RotatingLogFileMetadata). I’ll keep the change documentation-only and narrowly scoped, and will include the project’s verification results when I open the PR.
Activity
[-] Missing javadoc[/-][+]Add Javadoc to public API[/+]brunoborges commentedon Feb 26, 2026
/relevance-check
github-actions commentedon Feb 26, 2026
Relevance Assessment: Still Relevant
Summary: The public API still has significant Javadoc gaps. Only ~34% of Java files in the
api/module have class-level Javadoc, and the situation is similar in theparser/module.Evidence:
api/module: 48 out of 140 Java files (~34%) have class-level Javadoc comments. 92 files are missing class-level Javadoc entirely, including key classes likeDiary.java,Diarizer.java,SupportedFlags.java, and many event/summary classes.parser/module: 21 out of 62 Java files (~34%) have class-level Javadoc.vertx/module: 8 out of 9 files have class-level Javadoc — this module is in good shape, likely thanks to PR minimal javadoc for vertx and parser to satisfy release task #403.Recommendation: ✅ Keep open — This issue remains valid and actionable. The Javadoc coverage of the public API is still substantially incomplete. The only merged Javadoc work (PR minimal javadoc for vertx and parser to satisfy release task #403) was a minimal effort to unblock a release, not a comprehensive documentation pass. The labels (
documentation,enhancement,good first issue) are still appropriate for contributors looking to help.Danielweng0902 commentedon Jun 18, 2026
Hi, I can take a focused first pass here.
Instead of trying to cover the whole public API in one large PR, I’ll start with a small set of missing class-level Javadocs in the
apimodule, such as the key classes called out in the relevance check, and keep the PR narrowly scoped so it is easier to review.AubaidAhmedSaiyed commentedon Aug 11, 2026
is this still an issue on?
Anikesh348 commentedon Aug 11, 2026
Hi! I’m working on a focused, non-overlapping slice of this issue: completing the missing public-API Javadocs for the
com.microsoft.gctoolkit.iosegment and metadata contracts (LogFileSegment,LogFileMetadata,SingleLogFileMetadata, andRotatingLogFileMetadata). I’ll keep the change documentation-only and narrowly scoped, and will include the project’s verification results when I open the PR.AzazelSensei commentedon Aug 30, 2026
Opened #584.
Add class Javadoc for public event summary types #264 (#584)