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

Include fully-qualified class name of contract classes in Dartdoc #84

Open

Albert221 opened this issue Jan 10, 2023 · 0 comments

Member

Albert221 commented Jan 10, 2023 •

edited

Loading

To avoid confusing different classes from contracts (or to be extra sure) we could include the FQCN in the Dartdoc of every class.

Right now:

/// LeanCode.Contracts.Security.AuthorizeWhenHasAnyOfAttribute('dealer')
@ContractsSerializable()
class SetPreferences with EquatableMixin implements Command {
  SetPreferences({
    required this.domesticOnly
    // (...)

My proposal:

/// Original FQCN: LeanCode.Cars.Contracts.Dealer.TopDeals.SetPreferences
///
/// Attributes:
/// * LeanCode.Contracts.Security.AuthorizeWhenHasAnyOfAttribute('dealer')
@ContractsSerializable()
class SetPreferences with EquatableMixin implements Command {
  SetPreferences({
    required this.domesticOnly
    // (...)

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