slreportgen.report.DocBlock.customizeReporter

Class: slreportgen.report.DocBlock
Package: slreportgen.report

Create custom DocBlock reporter class

Syntax

reporter = slreportgen.report.DocBlock.customizeReporter(classpath)

Description

reporter = slreportgen.report.DocBlock.customizeReporter(classpath) creates a class definition file that defines a subclass of slreportgen.report.DocBlock at the location specified by classpath. The method also copies the default reporter templates to the resources/template subfolder of the folder that contains the class definition file. You can use the class definition file as a starting point to design a custom DocBlock reporter class for your report.

Input Arguments

expand all

Path and name of new class definition file, specified as a string scalar or character vector.

You can specify a relative path or an absolute path. For example, this code creates MyClass.m in the subfolder myFolder of the current folder.

slreportgen.report.DocBlock.customizeReporter("myFolder/MyClass")

To create the reporter class in a class folder, precede the class name with the @ character. Do not specify the .m extension. For example, this code creates MyClass.m in the subfolder myFolder/@MyClass in the current folder.

slreportgen.report.DocBlock.customizeReporter("myFolder/@MyClass")
See Folders Containing Class Definitions (MATLAB).

To create the reporter class in a class package, precede the folder name with the + character. For example, this code creates a DocBlock reporter in the myOrg package folder in the current folder.

slreportgen.report.DocBlock.customizeReporter("+myOrg/@DocBlock");

Output Arguments

expand all

Path and file name of the new DocBlock reporter class, returned as a string scalar.

Examples

expand all

Create a custom DocBlock reporter, MyDocBlock, and its associated default templates in the subfolder MyFolder of the current working folder.

slreportgen.report.DocBlock.customizeReporter('MyFolder/MyDocBlock')
ans = 

    "MyFolder\MyDocBlock.m"

After editing this new class file, you can use it as your DocBlock reporter.

rptr = MyDocBlock();

Create a custom DocBlock reporter and its associated default templates in a class folder that is a subfolder of a package folder.

slreportgen.report.DocBlock.customizeReporter("+MyPackage/@MyDocBlock")
ans = 

    "+MyPackage\@MyDocBlock\MyDocBlock.m"

After editing this new class file, you can use it as your DocBlock reporter.

rptr = MyPackage.MyDocBlock();

Introduced in R2019b