search

leancodepl / contractsgenerator-dart

Dart contracts client generator for a CQRS API
3 stars 1 forks source link

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

Open Albert221 opened 1 year ago

Albert221 commented 1 year ago

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
    // (...)