generateDocComment static method

String generateDocComment(
  1. RouteInfo routeInfo
)

Generate documentation comment

Implementation

static String generateDocComment(RouteInfo routeInfo) {
  final buffer = StringBuffer();
  buffer.writeln('/// Generated route for ${routeInfo.className}');

  if (routeInfo.description != null) {
    buffer.writeln('/// ${routeInfo.description}');
  }

  buffer.writeln('/// Path: ${routeInfo.path}');

  if (routeInfo.requiredParams.isNotEmpty) {
    buffer.writeln(
        '/// Required parameters: ${routeInfo.requiredParams.join(', ')}');
  }

  if (routeInfo.optionalParams.isNotEmpty) {
    buffer.writeln(
        '/// Optional parameters: ${routeInfo.optionalParams.join(', ')}');
  }

  return buffer.toString();
}