Skip to content

Commit

Permalink
Don't include some internal functions in the auto generated documenta…
Browse files Browse the repository at this point in the history
…tion.
  • Loading branch information
nickmbailey committed Apr 6, 2012
1 parent 1364f21 commit 8b11652
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions src/main/clojure/clojure/java/jmx.clj
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -80,13 +80,14 @@
[javax.management.remote JMXConnectorFactory JMXServiceURL])) [javax.management.remote JMXConnectorFactory JMXServiceURL]))


(def ^{:dynamic true (def ^{:dynamic true
:doc "The connection to be used for JMX ops. Defaults to the local process."} :doc "The connection to be used for JMX ops. Defaults to the local process."
:skip-wiki true}
*connection* *connection*
(ManagementFactory/getPlatformMBeanServer)) (ManagementFactory/getPlatformMBeanServer))


(declare jmx->clj) (declare jmx->clj)


(defn jmx-url (defn ^{:skip-wiki true} jmx-url
"Build a JMX URL from options." "Build a JMX URL from options."
([] (jmx-url {})) ([] (jmx-url {}))
([overrides] ([overrides]
Expand Down Expand Up @@ -121,7 +122,7 @@
(def ^{:private true} simplify-tabular-data-key (def ^{:private true} simplify-tabular-data-key
(comp maybe-keywordize maybe-atomize)) (comp maybe-keywordize maybe-atomize))


(defprotocol Destract (defprotocol ^{:skip-wiki true} Destract
(objects->data [_] "Convert JMX object model into data. Handles CompositeData, TabularData, maps, and atoms.")) (objects->data [_] "Convert JMX object model into data. Handles CompositeData, TabularData, maps, and atoms."))


(extend-protocol Destract (extend-protocol Destract
Expand Down Expand Up @@ -187,10 +188,10 @@
(binding [*connection* (.getMBeanServerConnection connector#)] (binding [*connection* (.getMBeanServerConnection connector#)]
~@body)))) ~@body))))


(defn mbean-info [n] (defn ^{:skip-wiki true} mbean-info [n]
(.getMBeanInfo *connection* (as-object-name n))) (.getMBeanInfo *connection* (as-object-name n)))


(defn raw-read (defn ^{:skip-wiki true} raw-read
"Read a list of mbean properties. Returns low-level Java object "Read a list of mbean properties. Returns low-level Java object
models for composites, tabulars, etc. Most callers should use models for composites, tabulars, etc. Most callers should use
read." read."
Expand Down Expand Up @@ -226,7 +227,7 @@
(as-object-name n) (as-object-name n)
(Attribute. (name attr) value))) (Attribute. (name attr) value)))


(defn attribute-info (defn ^{:skip-wiki true} attribute-info
"Get the MBeanAttributeInfo for an attribute." "Get the MBeanAttributeInfo for an attribute."
[object-name attr-name] [object-name attr-name]
(filter #(= (name attr-name) (.getName %)) (filter #(= (name attr-name) (.getName %))
Expand All @@ -237,8 +238,8 @@
[n attr] [n attr]
(.isReadable (mbean-info n))) (.isReadable (mbean-info n)))


(defn operations (defn ^{:skip-wiki true} operations
"All oeprations available on an MBean." "All operations available on an MBean."
[n] [n]
(.getOperations (mbean-info n))) (.getOperations (mbean-info n)))


Expand Down Expand Up @@ -292,7 +293,7 @@
nil nil))) nil nil)))


(defn invoke (defn invoke
"Invoke an operation an an MBean." "Invoke an operation an an MBean. See also: invoke-signature"
[n op & args] [n op & args]
(apply invoke-signature n op (op-param-types n op) args)) (apply invoke-signature n op (op-param-types n op) args))


Expand Down

0 comments on commit 8b11652

Please sign in to comment.