.. vim: set fileencoding=utf-8:
.. -*- coding: utf-8 -*-
.. +--------------------------------------------------------------------------+
   |                                                                          |
   | Licensed under the Apache License, Version 2.0 (the "License");          |
   | you may not use this file except in compliance with the License.         |
   | You may obtain a copy of the License at                                  |
   |                                                                          |
   |     http://www.apache.org/licenses/LICENSE-2.0                           |
   |                                                                          |
   | Unless required by applicable law or agreed to in writing, software      |
   | distributed under the License is distributed on an "AS IS" BASIS,        |
   | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
   | See the License for the specific language governing permissions and      |
   | limitations under the License.                                           |
   |                                                                          |
   +--------------------------------------------------------------------------+

The application programming interface (API) of this library package is divided
into two parts: Primary and Auxiliary. The primary part consists of the core
functionality for which the package is being provided: concealment and
immutability of attributes and interception of API invocations. The auxiliary
part consists of various functionalities, which the package internally
utilizes, but which provide significant value beyond the confines of the
package.

Primary API Documentation
===============================================================================

Module ``lockup``
-------------------------------------------------------------------------------

.. automodule:: lockup
   :imported-members:

Module ``lockup.exceptions``
-------------------------------------------------------------------------------

.. automodule:: lockup.exceptions

Auxiliary API Documentation
===============================================================================

Module ``lockup.exceptionality``
-------------------------------------------------------------------------------

.. automodule:: lockup.exceptionality
   :imported-members:

Module ``lockup.exceptionality.our_factories``
-------------------------------------------------------------------------------

.. automodule:: lockup.exceptionality.our_factories

Module ``lockup.nomenclature``
-------------------------------------------------------------------------------

.. automodule:: lockup.nomenclature

Module ``lockup.reflection``
-------------------------------------------------------------------------------

.. automodule:: lockup.reflection

Module ``lockup.validators``
-------------------------------------------------------------------------------

.. automodule:: lockup.validators

Module ``lockup.visibility``
-------------------------------------------------------------------------------

.. automodule:: lockup.visibility