NDEVR
API Documentation
BoilerMaker

Reads a boilerplate copyright/license header template and applies file-specific substitutions, producing the standard header block for generated source files. More...

Collaboration diagram for BoilerMaker:
[legend]

Public Member Functions

String boiler (const File &file, LogPtr log) const
 Generates the boilerplate header text for the given file.

Public Attributes

String boiler_data
 Cached template data (loaded on first use).
File boiler_file = File("$(NDEVR_SOURCE_DIR)\\VS\\BoilerplateMaker\\Boiler.h")
 Path to the boilerplate template file.

Detailed Description

Reads a boilerplate copyright/license header template and applies file-specific substitutions, producing the standard header block for generated source files.

Definition at line 10 of file BoilerMaker.h.

Member Function Documentation

◆ boiler()

String BoilerMaker::boiler ( const File & file,
LogPtr log ) const
inline

Generates the boilerplate header text for the given file.

Parameters
[in]fileThe file to generate the boilerplate for (used for name and library substitution).
[in]logLog for status messages.
Returns
The complete boilerplate header string.

Definition at line 19 of file BoilerMaker.h.

References boiler(), boiler_data, boiler_file, Scanner::currentLine(), File::e_file_name, file, Scanner::nextLine(), String::replace(), and ApplicationResource::username.

Referenced by boiler().


The documentation for this class was generated from the following file: