Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Split modules' xdoc into separate pages #13097

Closed
16 tasks done
stoyanK7 opened this issue May 29, 2023 · 4 comments
Closed
16 tasks done

Split modules' xdoc into separate pages #13097

stoyanK7 opened this issue May 29, 2023 · 4 comments
Assignees
@stoyanK7
Labels
approved miscellaneous
Milestone
10.12.1

Comments

@stoyanK7
Copy link
Collaborator

stoyanK7 commented May 29, 2023 •
edited by nrmancuso

All modules are grouped by a category on a single page - https://checkstyle.sourceforge.io/config_filters.html

This issue aims to split them so that every module has its own page.

Categories to split:
@stoyanK7
Copy link
Collaborator Author

Can we disregard the config_ prefix for new xdoc files?

What should the folder structure look like?

  • xdoc/<check> - xdoc/abstractclassname.xml
  • xdoc/<category>/<check> - xdoc/naming/abstractclassname.xml
  • xdoc/checks/<category>/<check> - xdoc/checks/naming/abstractclassname.xml - I would go with this personally

What do you think?

@nrmancuso
Copy link
Member

Can we disregard the config_ prefix for new xdoc files?

I am good with this.

I also prefer option 3 for file structure.

@romani
Copy link
Member

romani commented May 29, 2023

xdoc/checks/naming/abstractclassname.xml

yes, lets do this.

@stoyanK7 stoyanK7 mentioned this issue May 29, 2023
Merged
romani pushed a commit that referenced this issue Jun 16, 2023
@stoyanK7 @romani
Issue #13097: Split annotation xdocs into separate pages
1a59eb9
@github-actions github-actions bot added this to the 10.12.1 milestone Jun 16, 2023
This was referenced Jun 17, 2023
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
nrmancuso pushed a commit that referenced this issue Jun 21, 2023
@stoyanK7 @nrmancuso
Issue #13097: Split whitespace xdocs into separate pages
96746b7
nrmancuso pushed a commit that referenced this issue Jun 21, 2023
@stoyanK7 @nrmancuso
Issue #13097: Split header xdocs into separate pages
c639083
nrmancuso pushed a commit that referenced this issue Jun 21, 2023
@stoyanK7 @nrmancuso
Issue #13097: Split blocks xdocs into separate pages
57796b1
nrmancuso pushed a commit that referenced this issue Jun 21, 2023
@stoyanK7 @nrmancuso
Issue #13097: Split metrics xdocs into separate pages
9035f72
nrmancuso pushed a commit that referenced this issue Jun 22, 2023
@stoyanK7 @nrmancuso
Issue #13097: Split header xdocs into separate pages
97298c2
nrmancuso pushed a commit that referenced this issue Jun 22, 2023
@stoyanK7 @nrmancuso
Issue #13097: Split modifiers xdocs into separate pages
63b0c4c
nrmancuso pushed a commit that referenced this issue Jun 22, 2023
@stoyanK7 @nrmancuso
Issue #13097: Split design xdocs into separate pages
8f5f5ab
nrmancuso pushed a commit that referenced this issue Jun 22, 2023
@stoyanK7 @nrmancuso
Issue #13097: Split regexp xdocs into separate pages
0b0eb50
nrmancuso pushed a commit that referenced this issue Jun 22, 2023
@stoyanK7 @nrmancuso
Issue #13097: Split misc xdocs into separate pages
af17b30
nrmancuso pushed a commit that referenced this issue Jun 22, 2023
@stoyanK7 @nrmancuso
Issue #13097: Split filefilters xdocs into separate pages
95def5a
nrmancuso pushed a commit that referenced this issue Jun 22, 2023
@stoyanK7 @nrmancuso
Issue #13097: Split naming xdocs into separate pages
7d610a5
romani pushed a commit that referenced this issue Jun 22, 2023
@stoyanK7 @romani
Issue #13097: Split javadoc xdocs into separate pages
45a8c54
romani pushed a commit that referenced this issue Jun 22, 2023
@stoyanK7 @romani
Issue #13097: Split coding xdocs into separate pages
4e47a3d
romani pushed a commit that referenced this issue Jun 22, 2023
@stoyanK7 @romani
Issue #13097: Split sizes xdocs into separate pages
d664a5e
nrmancuso pushed a commit that referenced this issue Jun 22, 2023
@stoyanK7 @nrmancuso
Issue #13097: Split filters xdocs into separate pages
b45db82
@nrmancuso
Copy link
Member

Closed via #13266

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@stoyanK7 stoyanK7

Labels
approved miscellaneous
Projects
Xdoc generation
Status: Done
Milestone
10.12.1
Development

No branches or pull requests
3 participants
@romani @stoyanK7 @nrmancuso