SethFalco/commandler
SethFalco/commandler
Watch
1
Code Issues 44 Pull requests Projects Releases Packages Activity Actions

Add seeAlso Property to Controllers #96

New issue
Open
opened 2020-06-04 01:34:03 +01:00 by Ghost · 1 comment
Ghost commented 2020-06-04 01:34:03 +01:00 (Migrated from codeberg.org)
Copy link

Feature Request

Description

This is a following up to the closing of #29.

Controllers should be able to mark other controllers as seeAlso which makes the generated
documentation/help denote related modules.

Motivation

This is helpful in cases where multiple commands might be split into different modules but are for a similar integration.

This should be functional both unidirectional and bidirectional by allowing controllers to define any module as seeAlso.

Interface

@CommandController
public class TwitchController {

}

@CommandController(seeAlso = TwitchController.class)
public class TwitchNotifyController {

}
# Feature Request <!-- If you feel a heading is irrelevant, just leave it empty or remove it. --> ## Description <!-- Explain what this is about, try to use full sentences, and make your point clear. --> This is a following up to the closing of #29. Controllers should be able to mark other controllers as `seeAlso` which makes the generated documentation/help denote related modules. ## Motivation <!-- Why is this a feature that should be implemented in Commandler rather than in your own project using it? What makes this fundamental, or reusable, or of demand to other developers? --> This is helpful in cases where multiple commands might be split into different modules but are for a similar integration. This should be functional both unidirectional and bidirectional by allowing controllers to define any module as `seeAlso`. ## Interface <!-- In some cases you may wish to propose an interface or method names to help describe how you'd want to use this, or for others to discuss and improve ahead of time before final implementation. --> ```java @CommandController public class TwitchController { } ``` ```java @CommandController(seeAlso = TwitchController.class) public class TwitchNotifyController { } ```
Ghost commented 2025-03-31 23:22:02 +01:00 (Migrated from codeberg.org)
Copy link

mentioned in commit d56063315e

mentioned in commit d56063315e419e0fdd19fffca67dc1187a134c02
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
i18n
4.0.1
Labels
Clear labels   
bug
Something that's not working as intended in an existing project's functionality.

  
feature-request
A brand new feature for an existing project.

  
upstream
Should be resolved through an upstream contribution.

No labels
bug
feature-request
upstream
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
SethFalco/commandler#96
No description provided.