Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add class documentation #123

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions irteus/irtmodel.l
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@
:slots (parent-link child-link joint-angle min-angle max-angle default-coords
joint-velocity joint-acceleration joint-torque
max-joint-velocity max-joint-torque
joint-min-max-table joint-min-max-target))
joint-min-max-table joint-min-max-target)
:documentation "abstract class of joint, users need to use rotational-joint, linear-joint, sphere-joint, 6dof-joint, wheel-joint or omniwheel-joint." )

(defmethod joint
(:init (&key (name (intern (format nil "joint~A" (sys::address self)) "KEYWORD"))
Expand All @@ -44,8 +45,7 @@
((:joint-min-max-table mm-table))
((:joint-min-max-target mm-target))
&allow-other-keys)
"abstract class of joint, users need to use rotational-joint, linear-joint, sphere-joint, 6dof-joint, wheel-joint or omniwheel-joint.
use :parent-link/:child-link for specifying links that this joint connect to and :min/:min for range of joint angle in degree."
"use :parent-link/:child-link for specifying links that this joint connect to and :min/:min for range of joint angle in degree."
(send self :name name)
(setq parent-link plink child-link clink
min-angle min max-angle max)
Expand Down