Changed documentation for refactored functions, for clean up. Issue #104

.

docs/source/mmSolver.api.rst

@@ -96,15 +96,15 @@ Camera
 .. autoclass:: mmSolver.api.Camera
    :members:
    :undoc-members:
-   :special-members: __init__
+   :special-members:
 
 Bundle
 ++++++
 
 .. autoclass:: mmSolver.api.Bundle
    :members:
    :undoc-members:
-   :special-members: __init__
+   :special-members:
 
 Marker
 ++++++
@@ -114,7 +114,13 @@ Marker
 .. autoclass:: mmSolver.api.Marker
    :members:
    :undoc-members:
-   :special-members: __init__
+   :special-members:
+
+.. autofunction:: mmSolver.api.update_deviation_on_markers
+
+.. autofunction:: mmSolver.api.calculate_marker_deviation
+
+.. autofunction:: mmSolver.api.get_markers_start_end_frames
 
 MarkerGroup
 +++++++++++
@@ -124,7 +130,7 @@ A group containing Marker nodes.
 .. autoclass:: mmSolver.api.MarkerGroup
    :members:
    :undoc-members:
-   :special-members: __init__
+   :special-members:
 
 Attribute
 +++++++++
@@ -134,39 +140,41 @@ Attribute that will be solved.
 .. autoclass:: mmSolver.api.Attribute
    :members:
    :undoc-members:
-   :special-members: __init__
+   :special-members:
 
 Frame
 +++++
 
 .. autoclass:: mmSolver.api.Frame
    :members:
    :undoc-members:
-   :special-members: __init__
+   :special-members:
 
 Solver
 ++++++
 
 .. autoclass:: mmSolver.api.Solver
    :members:
    :undoc-members:
-   :special-members: __init__
+   :special-members:
 
 Collection
 ++++++++++
 
 .. autoclass:: mmSolver.api.Collection
    :members:
    :undoc-members:
-   :special-members: __init__
+   :special-members:
+
+.. autofunction:: mmSolver.api.update_deviation_on_collection
 
 SolveResult
 +++++++++++
 
 .. autoclass:: mmSolver.api.SolveResult
    :members:
    :undoc-members:
-   :special-members: __init__
+   :special-members:
 
 .. autofunction:: mmSolver.api.combine_timer_stats
 
@@ -176,40 +184,98 @@ SolveResult
 
 .. autofunction:: mmSolver.api.get_max_frame_error
 
+Naming
+++++++
+
+.. autofunction:: mmSolver.api.find_valid_maya_node_name
+
+.. autofunction:: mmSolver.api.get_new_marker_name
+
+.. autofunction:: mmSolver.api.get_new_bundle_name
+
+
 Utilities
 +++++++++
 
-.. autofunction:: mmSolver.api.get_long_name
+.. autofunction:: mmSolver.api.load_plugin
 
-.. autofunction:: mmSolver.api.get_as_selection_list
+.. autofunction:: mmSolver.api.get_object_type
 
-.. autofunction:: mmSolver.api.get_as_dag_path
 
-.. autofunction:: mmSolver.api.get_as_object
+State
++++++
 
-.. autofunction:: mmSolver.api.get_as_plug
+.. autofunction:: mmSolver.api.is_solver_running
 
-.. autofunction:: mmSolver.api.get_object_type
+.. autofunction:: mmSolver.api.set_solver_running
 
-.. autofunction:: mmSolver.api.convert_valid_maya_name
+.. autofunction:: mmSolver.api.get_user_interrupt
 
-.. autofunction:: mmSolver.api.get_marker_name
+.. autofunction:: mmSolver.api.set_user_interrupt
 
-.. autofunction:: mmSolver.api.get_bundle_name
+Node Conversions
+++++++++++++++++
 
-.. autofunction:: mmSolver.api.load_plugin
+The :mod:`mmSolver.api` module provides functions to convert between
+various node types. Currently the following conversions are supported:
 
-.. autofunction:: mmSolver.api.get_data_on_node_attr
+- Bundles -> Markers
+- Markers -> Bundles
+- Markers -> Cameras
 
-.. autofunction:: mmSolver.api.set_data_on_node_attr
+.. autofunction:: mmSolver.api.get_marker_nodes_from_bundle_nodes
 
-.. autofunction:: mmSolver.api.get_value_on_node_attr
+.. autofunction:: mmSolver.api.get_bundle_nodes_from_marker_nodes
 
-.. autofunction:: mmSolver.api.set_value_on_node_attr
+.. autofunction:: mmSolver.api.get_camera_nodes_from_marker_nodes
 
-.. autofunction:: mmSolver.api.is_solver_running
+Nodes Filter
+++++++++++++
 
-.. autofunction:: mmSolver.api.set_solver_running
+.. autofunction:: mmSolver.api.filter_nodes_into_categories
+
+.. autofunction:: mmSolver.api.filter_marker_nodes
+
+.. autofunction:: mmSolver.api.filter_marker_group_nodes
+
+.. autofunction:: mmSolver.api.filter_bundle_nodes
+
+.. autofunction:: mmSolver.api.filter_camera_nodes
+
+.. autofunction:: mmSolver.api.filter_collection_nodes
+
+Exceptions
+++++++++++
+
+.. autoclass:: mmSolver.api.MMException
+   :members:
+   :undoc-members:
+   :special-members:
+
+.. autoclass:: mmSolver.api.NotValid
+   :members:
+   :undoc-members:
+   :special-members:
+
+.. autoclass:: mmSolver.api.AlreadyLinked
+   :members:
+   :undoc-members:
+   :special-members:
+
+.. autoclass:: mmSolver.api.AlreadyUnlinked
+   :members:
+   :undoc-members:
+   :special-members:
+
+.. autoclass:: mmSolver.api.NotEnoughMarkers
+   :members:
+   :undoc-members:
+   :special-members:
+
+.. autoclass:: mmSolver.api.SolverNotAvailable
+   :members:
+   :undoc-members:
+   :special-members:
 
 Constants
 +++++++++
@@ -244,6 +310,8 @@ referenced inside the documentation.
 
 .. autoattribute:: mmSolver.api.SOLVER_TYPE_LEVMAR
 
+.. autoattribute:: mmSolver.api.SOLVER_TYPE_CMINPACK_LM
+
 .. autoattribute:: mmSolver.api.AUTO_DIFF_TYPE_FORWARD
 
 .. autoattribute:: mmSolver.api.AUTO_DIFF_TYPE_CENTRAL

docs/source/mmSolver.tools.attachbundletocurve.rst

@@ -12,6 +12,13 @@ Tools
     :members:
     :undoc-members:
 
+Library
++++++++
+
+.. automodule:: mmSolver.tools.attachbundletocurve.lib
+    :members:
+    :undoc-members:
+
 Constants
 +++++++++
 

docs/source/mmSolver.tools.selection.rst

@@ -1,35 +1,15 @@
 mmSolver.tools.selection
 ========================
 
-This package contains all selection tools related to solver, marker, and bundle.
+This package contains all selection tools related to solver, marker, and bundle nodes.
+
+.. note::
+   This module once contained 'filternodes' and 'convert' sub-modules.
+   Modules have been refactored into :mod:`mmSolver.api`
 
 Tools
 +++++
 
 .. automodule:: mmSolver.tools.selection.tools
    :members:
    :undoc-members:
-
-Convert
-+++++++
-
-The :mod:`mmSolver.tools.selection.convert` module provides functions
-to convert between various node types. Currently the following
-convertions are supported:
-
-- Markers -> Bundles
-- Bundles -> Markers
-- Markers -> Cameras
-
-.. autofunction:: mmSolver.tools.selection.convert.get_bundles_from_markers
-
-.. autofunction:: mmSolver.tools.selection.convert.get_markers_from_bundles
-
-.. autofunction:: mmSolver.tools.selection.convert.get_cameras_from_markers
-
-Filter Nodes
-++++++++++++
-
-.. automodule:: mmSolver.tools.selection.filternodes
-   :members:
-   :undoc-members:

python/mmSolver/api.py

@@ -180,13 +180,6 @@
     'calculate_marker_deviation',
     'get_markers_start_end_frames',
 
-    # Collection Utils
-    'is_single_frame',
-    'disconnect_animcurves',
-    'reconnect_animcurves',
-    'clear_attr_keyframes',
-    'generate_isolate_nodes',
-
     # Naming
     'find_valid_maya_node_name',
     'get_new_marker_name',
@@ -213,7 +206,6 @@
 
     # Utilities Functions
     'load_plugin',
-    'get_long_name',
     'get_object_type',
     'get_data_on_node_attr',
     'set_data_on_node_attr',