overview property

  1. @TagNumber.new(2)
String get overview

Declares a single overview page. For example:

documentation:
  summary: ...
  overview: (== include overview.md ==)

This is a shortcut for the following declaration (using pages style):

documentation:
  summary: ...
  pages:
  - name: Overview
    content: (== include overview.md ==)

Note: you cannot specify both overview field and pages field.

Implementation

@$pb.TagNumber(2)
$core.String get overview => $_getSZ(1);
  1. @TagNumber.new(2)
set overview (String value)

Implementation

@$pb.TagNumber(2)
set overview($core.String value) => $_setString(1, value);