Permalink
Browse files

Added a bit of documentation.

  • Loading branch information...
1 parent 8765829 commit d44ac3481cd8c3eaaabf7e491efd1423dd6c485c @smithzvk committed Jul 7, 2011
Showing with 9 additions and 0 deletions.
  1. +9 −0 modf.lisp
View
@@ -66,12 +66,21 @@ benefit, not the users, as these symbols belong to the MODF package."
(package-name (symbol-package symbol))
":" (symbol-name symbol) ))
+;; @The macro <<modf-fn>> provides a similar functionality to <<setf>>'s
+;; <<#'(setf fn)>>. This can be used to access the function Modf will use to
+;; invert a form.
+
;;<<>>=
(defmacro modf-fn (symbol)
"Expand to the defined Modf function. Basically, \(MODF-FN SYM) is the
functional analog of #'\(SETF SYM)."
`(function ,(intern (modf-name symbol) :modf)) )
+;; @The macros <<define-modf-function>> and <<define-modf-method>> are a way to
+;; define a function or method that Modf will call with the new value and the
+;; arguments to the accessor. This function should invert the accessor into a
+;; builder.
+
;; <<>>=
(defmacro define-modf-function (name nth-arg (new-val &rest args) &body body)
"Define a new modf function. It inverts NAME forms by modifying the NTH-ARG

0 comments on commit d44ac34

Please sign in to comment.