Skip to content
Snippets Groups Projects
Commit c795da47 authored by Christophe Rhodes's avatar Christophe Rhodes
Browse files

added some docstrings

parent b48328bc
No related branches found
No related tags found
No related merge requests found
...@@ -84,7 +84,7 @@ ...@@ -84,7 +84,7 @@
;; because quite often that's not what we actually use it for) ;; because quite often that's not what we actually use it for)
(pathname :initarg :pathname))) (pathname :initarg :pathname)))
(defmethod string-unix-common-casify (string &key (start 0) end) (defun string-unix-common-casify (string &key (start 0) end)
"Converts a string assumed local to a Unix filesystem into its "Converts a string assumed local to a Unix filesystem into its
:common :case partner." :common :case partner."
(unless end (unless end
...@@ -97,6 +97,8 @@ ...@@ -97,6 +97,8 @@
(nstring-upcase result :start start :end end)) (nstring-upcase result :start start :end end))
(t result)))) (t result))))
(defgeneric component-pathname (component)
(:documentation "Extracts the pathname applicable for a particular component."))
(defmethod component-pathname ((component component)) (defmethod component-pathname ((component component))
(let ((*default-pathname-defaults* *component-parent-pathname*)) (let ((*default-pathname-defaults* *component-parent-pathname*))
...@@ -128,6 +130,11 @@ ...@@ -128,6 +130,11 @@
(make-pathname :directory `(:relative ,(component-name component)) (make-pathname :directory `(:relative ,(component-name component))
:host (pathname-host *component-parent-pathname*))) :host (pathname-host *component-parent-pathname*)))
(defgeneric find-component (module name)
(:documentation "Finds the component with name NAME present in the
MODULE module; if MODULE is nil, then the component is assumed to be a
system."))
(defmethod find-component ((module module) name) (defmethod find-component ((module module) name)
(if (slot-boundp module 'components) (if (slot-boundp module 'components)
(find name (module-components module) (find name (module-components module)
...@@ -426,11 +433,13 @@ ...@@ -426,11 +433,13 @@
if b append b into bindings if b append b into bindings
finally (return (values initargs bindings)))) finally (return (values initargs bindings))))
;;; process-option returns as its first value a list of initargs that (defgeneric process-option (option value)
;;; eventually gets appended to a call to reinitialize instance; its (:documentation "returns as its first value a list of initargs that
;;; optional second value is a list of binding clauses suitable for a eventually gets appended to a call to reinitialize instance; its
;;; let that may be referred to in the initargs. optional second value is a list of binding clauses suitable for a let
(defmethod process-option (option value) that may be referred to in the initargs."))
(defmethod process-option (option value)
(list option value)) (list option value))
#| #|
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment