Main Content

slreportgen.report.DocBlock.getDocBlockFile

Class: slreportgen.report.DocBlock
Namespace: slreportgen.report

Get path of content file for DocBlock reporter

Since R2022a

Syntax

fileLoc = slreportgen.report.DocBlock.getDocBlockFile(docBlockRptr,report)

Description

fileLoc = slreportgen.report.DocBlock.getDocBlockFile(docBlockRptr,report) creates a file that contains the contents of the DocBlock reporter docBlockRptr and returns the full path to that file. Use the file path to access content within the DocBlock reporter.

Input Arguments

expand all

DocBlock reporter, specified as an object of slreportgen.report.DocBlock.

Report, specified as an slreportgen.report.Report object.

Output Arguments

expand all

Location of the DocBlock reporter content file, returned as a string.

Attributes

Statictrue

To learn about attributes of methods, see Method Attributes.

Version History

Introduced in R2022a