Code docs

[StarProxima]

Add summary of the methods to the code docs

Corresponds to effective dart: DO separate the first sentence of a doc comment into its own paragraph https://dart.dev/effective-dart/documentation#do-separate-the-first-sentence-of-a-doc-comment-into-its-own-paragraph

Before:

  /// Вернет True, если пользователь с указанным Email уже зарегистрирован, иначе False.
  @POST('/auth/email/verify')
  Future<VerifyEmailResponse> emailAuthEmailVerifyPost({
    @Body() required EmailForm body,
  });

After:

  /// Проверить Email На Существование
  /// 
  /// Вернет True, если пользователь с указанным Email уже зарегистрирован, иначе False.
  @POST('/auth/email/verify')
  Future<VerifyEmailResponse> emailAuthEmailVerifyPost({
    @Body() required EmailForm body,
  });

Fix indents for multiline code docs

Before:

  /// Проверить Email На Существование
/// 
/// Вернет True, если пользователь с указанным Email уже зарегистрирован, иначе False.
  @POST('/auth/email/verify')
  Future<VerifyEmailResponse> emailAuthEmailVerifyPost({
    @Body() required EmailForm body,
  });

After:

  /// Проверить Email На Существование
  /// 
  /// Вернет True, если пользователь с указанным Email уже зарегистрирован, иначе False.
  @POST('/auth/email/verify')
  Future<VerifyEmailResponse> emailAuthEmailVerifyPost({
    @Body() required EmailForm body,
  });

Add support for root client code docs

Before:

  class RestClient implements IRestClient {
      // ...
   }

After:

  /// Microservice Auth API `v0.2.3`
  /// 
  /// Auth API is a microservice for user authentication and authorization.
  /// It provides endpoints for user registration, login, email verification, token refresh and token verification.
  /// It also provides endpoints for getting user data from the database.
  class RestClient implements IRestClient {
      // ...
   }