Back

add-remote-javadoc (clj)

(source)

function

(add-remote-javadoc package-prefix url)
Adds to the list of remote Javadoc URLs. package-prefix is the beginning of the package name that has docs at this URL.

Examples

clojure/core.typed

(deftest javadoc-test
  (is-tc-e #(javadoc 1) [-> Any]
           :requires [[clojure.java.javadoc :refer [javadoc]]]))

(deftest add-remote-javadoc-test
  (is-tc-e #(add-remote-javadoc 
              "org.apache.commons.csv." 
              "http://commons.apache.org/proper/commons-csv/apidocs/index.html") 
           [-> (Map Any Any)]
           :requires [[clojure.java.javadoc :refer [add-remote-javadoc]]])
  (is-tc-err #(add-remote-javadoc 
                "org.apache.commons.csv."
                "http://commons.apache.org/proper/commons-csv/apidocs/index.html")
             [-> String]
             :requires [[clojure.java.javadoc :refer [add-remote-javadoc]]])
  (is-tc-err #(add-remote-javadoc 
                1 
                "http://commons.apache.org/proper/commons-csv/apidocs/index.html") 
             [-> (Map Any Any)]
             :requires [[clojure.java.javadoc :refer [add-remote-javadoc]]]))
typedclojure/typedclojure
(deftest javadoc-test
  (is-tc-e #(javadoc 1) [-> t/Any]
           :requires [[clojure.java.javadoc :refer [javadoc]]]))

(deftest add-remote-javadoc-test
  (is-tc-e #(add-remote-javadoc 
              "org.apache.commons.csv." 
              "http://commons.apache.org/proper/commons-csv/apidocs/index.html") 
           [-> (t/Map t/Any t/Any)]
           :requires [[clojure.java.javadoc :refer [add-remote-javadoc]]])
  (is-tc-err #(add-remote-javadoc 
                "org.apache.commons.csv."
                "http://commons.apache.org/proper/commons-csv/apidocs/index.html")
             [-> String]
             :requires [[clojure.java.javadoc :refer [add-remote-javadoc]]])
  (is-tc-err #(add-remote-javadoc 
                1 
                "http://commons.apache.org/proper/commons-csv/apidocs/index.html") 
             [-> (t/Map t/Any t/Any)]
             :requires [[clojure.java.javadoc :refer [add-remote-javadoc]]]))