QMAPP-mq / qudi

A modular laboratory experiment management suite.
GNU General Public License v3.0
4 stars 0 forks source link

docstring formatting #30

Closed mvbnano closed 6 years ago

mvbnano commented 6 years ago

What is affected by this bug?

All docstrings, class and function alike, should have consistent docstrings that are compatible with doxygen.

When does this occur?

In all our dev branches.

Where on the platform does it happen?

All class docstrings and all function docstrings.

Other Comments

Expected behaviour information to follow.

latchr commented 6 years ago

Needs to start with a one line short description then, a blank line.

For methods, need to have consistent param and return.