Main Content

slreportgen.report.DocBlock.getDocBlockFile

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

Get path of content file for DocBlock reporter

Syntax

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

Description

fileLoc = slreportgen.report.DocBlock.getDocBlockFile(docBlockRptr,rpt) 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.

Name of the report, specified as an object of slreportgen.report.Report.

Output Arguments

expand all

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

Version History

Introduced in R2022a