Documentation
¶
Overview ¶
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
Context string `yaml:"context"`
Input string `yaml:"input"`
Output string `yaml:"output"`
Template string `yaml:"template"`
Bookmark string `yaml:"bookmark"`
Logfile string `yaml:"logfile"`
Verbose bool `yaml:"verbose"`
Workdir string `yaml:"workdir"`
}
Config represents the configuration for docgen.
func LoadConfig ¶
LoadConfig reads and parses a YAML configuration file.
func (*Config) ApplyDefaults ¶
func (c *Config) ApplyDefaults()
ApplyDefaults sets default values for missing fields.
func (*Config) NormalizePaths ¶
func (c *Config) NormalizePaths()
NormalizePaths normalizes file paths relative to workdir.
Source Files
Click to show internal directories.
Click to hide internal directories.