OpenMS / pyopenms-docs

pyOpenMS readthedocs documentation, additional utilities, addons, scripts, and examples.
https://pyopenms.readthedocs.io
Other
42 stars 52 forks source link

Add class / API documentation #246

Closed timosachsenberg closed 2 years ago

timosachsenberg commented 2 years ago

To move forward with the automatic API/class documentation, we need to support multi-line comments for methods. Instead of having only a single line doc string like:

  void myfunction(int s) # wrap-doc:This is a doc string

we need support for:

  void myfunction(int s)
  # wrap-doc:
                #   blabla
                #   -----
                #   blablaba
                #   -----
                #   :param s: bla

I think this already works for classes but not for methods.

timosachsenberg commented 2 years ago

How this could be done:

jpfeuffer commented 2 years ago

An important thing to consider is that there might be multiline functions:

void myfunction(int s,
            bool b)

This might even be exploited for comments right now ;) Like this:

void myfunction(int s,  # this is a
            bool b)               # multiline comments
tapaswenipathak commented 2 years ago

Should @greengypsy or I takeover?

jpfeuffer commented 2 years ago

This should be done. See autowrap repository for the Multiline method doc fix. And see my recent commits here for the apidoc. We reopen if something does not work.