jeluard / lucuma

Web Components library for ClojureScript
96 stars 8 forks source link

Allow to define documentation #34

Closed jeluard closed 9 years ago

jeluard commented 10 years ago

It should be possible to provide a documentation for various defwebcomponent sections. This information should be available at runtime per type so that it can be used to generate some visual representation of it.

jeluard commented 10 years ago

Potential syntax:

(defn method1
  "This method does.."
  [el arg]
  nil)

(defwebcomponent my-documented-component
  "This component blablah.."
  [param]
  :properties {:property1 {:default 1 :events? false :doc "this does blah"}}
  :methods {:method1 method1})
jeluard commented 9 years ago

Out of scope.