Function autoGenHandlePage

scripts/genRef.py:736–775

Autogenerate a single handle page in baseDir for an API handle type. - baseDir - base directory to emit page into - handleName - API handle name

(baseDir, handleName)

def autoGenHandlePage(baseDir, handleName):
    """Autogenerate a single handle page in baseDir for an API handle type.

    - baseDir - base directory to emit page into
    - handleName - API handle name"""
    # @@ Need to determine creation function & add handles/ include for the
    # @@ interface in generator.py.
    pageName = f'{baseDir}/{handleName}{conventions.file_suffix}'
    fp = open(pageName, 'w', encoding='utf-8')

    # Add a dictionary entry for this page
    global genDict
    genDict[handleName] = None
    logDiag('autoGenHandlePage:', pageName)

    # Short description
    desc = f'{apiName} object handle'

    descText = ''.join((
        f'sname:{handleName}',
        ' is an object handle type, referring to an object used\n',
        f'by the {apiName} implementation. These handles are created or allocated\n',
        f'by the @@ TBD @@ function, and used by other {apiName} structures\n',
        'and commands in the See Also section below.\n'))

    refPageHead(pageName=handleName,
                pageDesc=desc,
                pageAliases=set(),
                specText=makeAPIInclude('handles', handleName),
                fieldName=None,
                fieldText=None,
                descText=descText,
                fp=fp)
    refPageTail(pageName=handleName,
                specType=pi.spec,
                specAnchor=pi.anchor,
                seeAlso=seeAlsoList(apiName=handleName),
                fp=fp,
                auto=True)
    fp.close()


def genRef(specFile, baseDir, aliasFrom):