String
detailedDescription
Source
@override
String get detailedDescription {
return "This tool will generate an OpenAPI specification of an Aqueduct application. It operates by invoking Application.document. "
"This method locates an application's RequestSink and invokes the first three phases of initialization:\n\n"
"\tRequestSink.initializeApplication\n"
"\tRequestSink's constructor\n"
"\tRequestSink.setupRouter\n\n"
"After these initialization methods are called, RequestSink.document is invoked. Note that the full initialization process does not"
" occur: RequestSink.willOpen and RequestSink.didOpen are not called because no web server is started. However, it is important that"
" the first three steps of initialization can occur without error when generating documentation. This often requires having a"
" valid configuration file (--config-path) when running this tool. The suggested approach is to use config.src.yaml as the configuration"
" file for the document tool. The flag 'isDocumenting' will be set to true in ApplicationConfiguration.";
}