Interface ICommenter

Namespace

FVNever.Reuse.Commenters

Assembly

FVNever.Reuse.dll

Entity that manages metadata comments in a text file.

public interface ICommenter

Methods

GenerateHeader(IEnumerable<string>, IEnumerable<string>)

Generate a string with metadata information that will be inserted at the beginning of the file.

string GenerateHeader(IEnumerable<string> copyrightStatements, IEnumerable<string> licenseIdentifiers)

Parameters

copyrightStatements IEnumerable<string>

The copyright statement collection.

licenseIdentifiers IEnumerable<string>

The license identifier collection.

Returns

string

Resulting string, ending with a newline.

RemoveHeader(string)

Remove metadata information from the file contents.

string RemoveHeader(string currentContent)

Parameters

currentContent string

Current file contents.

Returns

string

File contents without metadata information.