update api doc

This commit is contained in:
meeussen 2009-09-22 23:18:03 +00:00
parent 29b6edeafb
commit 50df33fc7b
2 changed files with 14 additions and 0 deletions

View File

@ -52,7 +52,12 @@ namespace robot_state_publisher{
class JointStateListener{ class JointStateListener{
public: public:
/** Constructor
* \param tree The kinematic model of a robot, represented by a KDL Tree
*/
JointStateListener(const KDL::Tree& tree); JointStateListener(const KDL::Tree& tree);
/// Destructor
~JointStateListener(); ~JointStateListener();
private: private:

View File

@ -48,9 +48,18 @@ namespace robot_state_publisher{
class RobotStatePublisher class RobotStatePublisher
{ {
public: public:
/** Constructor
* \param tree The kinematic model of a robot, represented by a KDL Tree
*/
RobotStatePublisher(const KDL::Tree& tree); RobotStatePublisher(const KDL::Tree& tree);
/// Destructor
~RobotStatePublisher(){}; ~RobotStatePublisher(){};
/** Publish transforms to tf
* \param joint_positions A map of joint names and joint positions.
* \param time The time at which the joint positions were recorded
*/
bool publishTransforms(const std::map<std::string, double>& joint_positions, const ros::Time& time); bool publishTransforms(const std::map<std::string, double>& joint_positions, const ros::Time& time);
private: private: