Check documentation on all files

ilent2 / ott

Optical Tweezers Toolbox (Version 1)

Other

51 stars 30 forks source link

Check documentation on all files #11

Closed ilent2 closed 6 years ago

ilent2 commented 6 years ago

Make usage consistent across all files
Function names should be in bold
Class names should match class declaration
Classes should have list of methods and properties
PACKAGE_INFO should be replaced by the following text

% This file is part of the optical tweezers toolbox. % See LICENSE.md for information about using/distributing this file.

ilent2 commented 6 years ago

Example of a file with ok documentation: ott-toolbox/xyz2rtp.m

ilent2 commented 6 years ago

I'm about half way through checking the documentation of files now.

ilent2 commented 6 years ago

@AStilg, could you take a look at the documentation for sbesselh, sbesselh2 and sbesselh1, spharm. Everything else should be mostly done. I think we are probably about ready for release.

ilent2 commented 6 years ago

Done in 70202a19828a3c96fb82f6e3cac468a12c77811c