QMol_info - fmauger1/QMol-grid GitHub Wiki

QMol_info

Run-time documentation for the implementation-specific components of the QMol-grid package.

Description

QMol_info overloads QMol_doc and defines an abstract class handling the implementation-specific components of the run-time documentation capabilities of the QMol-grid package. It also defines citable references for the implementation-specific components of the package.

Class properties

QMol_info does not define any member properties

Class methods

All the QMol_info methods are intended for run-time documentation purposes and not directly accessible to end users.

Creation

QMol_info is an abstract class and cannot be instantiated.

Test suite

For consistency with the rest of the QMol-grid package, QMol_info defines an associated test suite. Run the test suite for the class in normal or summary mode respectively with

QMol_test.test('info');
QMol_test.test('-summary','info');

For developers

The list of implementation-specific components is not automatically generated and one need to add the relevant entry in the showComponents method.

Notes

  • QMol_info was introduced in version 01.00.