lcm-proj / lcm

Lightweight Communications and Marshalling
GNU Lesser General Public License v2.1
980 stars 388 forks source link

doxygen, c++: LCM::subscribe for std::function<> doesn't show up? #357

Closed EricCousineau-TRI closed 3 years ago

EricCousineau-TRI commented 3 years ago

The code has the following (awesome) c++11 feature, for subscribing w/ std::function<>: https://github.com/lcm-proj/lcm/blob/98893d8cb34cc86203235f2e41b740bf216b97c3/lcm/lcm-cpp.hpp#L370-L427

However, I don't see this in Doxygen at present :crying_cat_face: https://lcm-proj.github.io/classlcm_1_1LCM.html

image

Perhaps a define just needs to be added to Doxyfile or sthg? Seems like it'd be useful, given that many projects may be using C++11 or above?

Relates #212

ashuang commented 3 years ago

Hi @EricCousineau-TRI Yes, the online documentation is unfortunately out of date because I haven't had a chance to regenerate and upload it. Would welcome any pull requests on https://github.com/lcm-proj/lcm-proj.github.io to update documentation

EricCousineau-TRI commented 3 years ago

Howdy @ashuang! I gave it a whirl, but got confused; can I ask for your help? https://github.com/lcm-proj/lcm-proj.github.io/pull/6

EricCousineau-TRI commented 3 years ago

Woot, works for me! Closing this for now! https://lcm-proj.github.io/classlcm_1_1LCM.html#a46d6d0c4831465186f6b8472a767fb58

image