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 defun2 for adding documentation to function written by C language #75

Closed
wants to merge 586 commits into from

Conversation

YoheiKakiuchi
Copy link
Member

I add defun2 function for adding documentation string to function writtin by C.

example in eus/c/arith.c
- defun(ctx,"=",mod,NUMEQUAL);                                                                                                 
+ defun2(ctx,"=",mod,NUMEQUAL,"euqal numbers");

We can take another strategy updating defun function as defun2 like and adding documentation to all existing code.

defun (ctx, "func", mod, FUNC) -> defun (ctx, "func", mod, FUNC, NULL)

related to jsk-ros-pkg/jsk_roseus#178

k-okada and others added 30 commits August 18, 2011 09:17
…l to find-initial-hull from r2255 of jsk/primtpatch.l, jsk/primtapp.l
@k-okada
Copy link
Member

k-okada commented Dec 5, 2014

I prefer
defun (ctx, "func", mod, FUNC) -> defun (ctx, "func", mod, FUNC, NULL)
to avoid writing documentation on what is the difference between defun and defun2.

@garaemon
Copy link
Contributor

garaemon commented Dec 5, 2014

defun2!! it sounds bad. at least, it should be 'defun_with_doc'

@YoheiKakiuchi
Copy link
Member Author

In C, we can't use optional argument.
So if number of arguments is changed, we should change all codes (such as roseus.cpp ...)

@k-okada
Copy link
Member

k-okada commented Dec 5, 2014

yes, that's ok and I think we do not use such source code other than
roseus.cpp

Kei Okada

On Fri, Dec 5, 2014 at 2:28 PM, Yohei Kakiuchi [email protected]
wrote:

In C, we can't use optional argument.
So if number of arguments is changed, we should change all codes (such as
roseus.cpp ...)


Reply to this email directly or view it on GitHub
#75 (comment).

@k-okada
Copy link
Member

k-okada commented May 13, 2015

rebased and create new PR #111

@k-okada k-okada closed this May 13, 2015
mmurooka pushed a commit to mmurooka/EusLisp that referenced this pull request Jan 4, 2018
Travis passed and separation of file has been completed. 
euslisp/jskeus#73
Merged.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants