Yarp: clean up examples, build, and documentation for yarp bindings

Created on 17 Nov 2014  路  8Comments  路  Source: robotology/yarp

  • @apaikan suggests moving examples out of bindings directory (see https://github.com/robotology/yarp/pull/316#issuecomment-63243795), also giving better examples that show language specific syntax.
  • @drdanz suggests turning off old method of building bindings separately (see https://github.com/robotology/yarp/pull/316#issuecomment-63272307).
  • @arocchi proposes a set of cleanups for matlab bindings, see #314.
  • I've always wanted to run the equivalent of javadoc on each set of bindings and publish that output so that it is clear what the API is for each language.
Bindings

Most helpful comment

Related to

I've always wanted to run the equivalent of javadoc on each set of bindings and publish that output so that it is clear what the API is for each language.

The doxygen branch was merged in SWIG ( https://github.com/swig/swig/pull/170#issuecomment-395465608 ), so that feature should be part of the next release.

SWIG 4 has been released, with the javadoc/pydoc feature available: https://sourceforge.net/p/swig/news/2019/04/swig-400-released/ .

All 8 comments

I guess this swig branch: https://github.com/swig/swig/pull/170 is related to the last point.

Oh beautiful! Thanks @traversaro.

cc @francesco-romano

Note that apparently building bindings externally using a binary release of YARP is still a thing on Windows: https://github.com/robotology/yarp/issues/698 .

@drdanz and me discussed about this.
I don't remember if we kept this "feature" or if we deprecated it, but for sure it should be still included in the bindings refactoring

Related to

I've always wanted to run the equivalent of javadoc on each set of bindings and publish that output so that it is clear what the API is for each language.

The doxygen branch was merged in SWIG ( https://github.com/swig/swig/pull/170#issuecomment-395465608 ), so that feature should be part of the next release.

Related to

I've always wanted to run the equivalent of javadoc on each set of bindings and publish that output so that it is clear what the API is for each language.

The doxygen branch was merged in SWIG ( https://github.com/swig/swig/pull/170#issuecomment-395465608 ), so that feature should be part of the next release.

SWIG 4 has been released, with the javadoc/pydoc feature available: https://sourceforge.net/p/swig/news/2019/04/swig-400-released/ .

Was this page helpful?
0 / 5 - 0 ratings