Directives

Table of Contents
Documentation
Modules
Conditional Elements
C++ and Header Code Sections
Python Code Sections
Mapped Classes
Special Python methods
Other

Documentation

Table of Contents
%Copying — Start of software license _block_
%Doc — Start of a documentation _block_
%ExportedDoc — Start of an exported documentation _block_

%Copying

Name

%Copying -- Start of software license _block_

Synopsis

%Copying

Remarks

If more than one is given, all blocks are included in the order of evaluation. Copying blocks are not extracted from imported modules.


%Doc

Name

%Doc -- Start of a documentation _block_

Synopsis

%Doc

Description

If SIP option "-d doc_file" is used, these blocks are collected (in the order of evaluation) from within the main module but ignored on all imported modules and put into the doc_file.


%ExportedDoc

Name

%ExportedDoc -- Start of an exported documentation _block_

Synopsis

%ExportedDoc

Description

If SIP option "-d doc_file" is used, these blocks are collected from all modules (incl. imported modules) and put into the doc_file.