jsdoc explaining use of undefined projectId

Author: benjiwheeler

src/lib/project-saver-hoc.jsx

@@ -21,8 +21,6 @@ import {
  * <ProjectSaverHOC>
  *     <WrappedComponent />
  * </ProjectSaverHOC>
- *
- * storeProject(projectId): undefined value will cause POST/create; defined id will cause PUT/update
  */
 const ProjectSaverHOC = function (WrappedComponent) {
     class ProjectSaverComponent extends React.Component {
@@ -49,6 +47,11 @@ const ProjectSaverHOC = function (WrappedComponent) {
                     });
             }
         }
+        /**
+         * storeProject:
+         * @param  {number|string|undefined} projectId defined value causes PUT/update; undefined causes POST/create
+         * @return {Promise} resolves with json object containing project's existing or new id
+         */
         storeProject (projectId) {
             return this.props.vm.saveProjectSb3()
                 .then(content => {
@@ -62,7 +65,7 @@ const ProjectSaverHOC = function (WrappedComponent) {
                         assetType,
                         dataFormat,
                         body,
-                        projectId // undefined value will cause POST/create; defined id will cause PUT/update
+                        projectId
                     );
                 });
         }

src/lib/vm-manager-hoc.jsx

@@ -83,10 +83,10 @@ const vmManagerHOC = function (WrappedComponent) {
 
     VMManager.propTypes = {
         isLoadingWithId: PropTypes.bool,
+        loadingState: PropTypes.oneOf(LoadingStates),
         onLoadedProject: PropTypes.func,
         projectData: PropTypes.oneOfType([PropTypes.object, PropTypes.string]),
         projectId: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
-        loadingState: PropTypes.oneOf(LoadingStates),
         vm: PropTypes.instanceOf(VM).isRequired
     };