8000 [FEATURE REQUEST] Documentation about the available configurations · Issue #161 · lisa-analyzer/lisa · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

[FEATURE REQUEST] Documentation about the available configurations #161

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
Open
lucaneg opened this issue Jan 21, 2022 · 0 comments
8000
Open

[FEATURE REQUEST] Documentation about the available configurations #161

lucaneg opened this issue Jan 21, 2022 · 0 comments
Assignees
@lucaneg
Labels
⁉ priority:p2 Priority planning - level 2 📑 scope:docs Improvements or additions to documentation

Comments

@lucaneg
Copy link
Member
lucaneg commented Jan 21, 2022

Description
LiSAFactory.configurableComponents() can return a list of concrete implementation of the analysis components that can be configured. This, as well as information about options inside LiSAConfiguration, should end up in the documentation website. To properly identify availability of these implementations, we should also annotate them with the first release that they were available in.

Suggested implementation
Documentation-related annotations on classes and fields for both description and availability, with a small gradle task that can access them to generate the documentation files.
@lucaneg lucaneg added 📑 scope:docs Improvements or additions to documentation ⁉ priority:p2 Priority planning - level 2 labels Jan 21, 2022
@lucaneg lucaneg added this to the 0.1b5 milestone Jan 21, 2022
@lucaneg lucaneg self-assigned this Jan 21, 2022
@lucaneg lucaneg modified the milestones: 0.1b5, 0.1b6 Feb 21, 2022
@lucaneg lucaneg removed this from the 0.1b6 milestone May 9, 2022
@lucaneg lucaneg moved this to Todo in LiSA Nov 3, 2022
@lucaneg lucaneg added this to LiSA Nov 3, 2022
@lucaneg lucaneg moved this from Todo to Backlog in LiSA Nov 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lucaneg lucaneg

Labels
⁉ priority:p2 Priority planning - level 2 📑 scope:docs Improvements or additions to documentation
Projects
LiSA
Status: Backlog
Milestone
No milestone
Development

No branches or pull requests
1 participant
@lucaneg
0