📄 documenter.html
字号:
<FONT color="green">252</FONT> documentType(doc.returnType());<a name="line.252"></a>
<FONT color="green">253</FONT> // close the returns with an optional comment: </returns><a name="line.253"></a>
<FONT color="green">254</FONT> Tag[] tags = doc.tags("@return");<a name="line.254"></a>
<FONT color="green">255</FONT> if (tags.length != 0) {<a name="line.255"></a>
<FONT color="green">256</FONT> System.out.print("><![CDATA[");<a name="line.256"></a>
<FONT color="green">257</FONT> System.out.print(tags[0].text());<a name="line.257"></a>
<FONT color="green">258</FONT> System.out.println("]]></returns>");<a name="line.258"></a>
<FONT color="green">259</FONT> } else<a name="line.259"></a>
<FONT color="green">260</FONT> System.out.println(" />");<a name="line.260"></a>
<FONT color="green">261</FONT> }<a name="line.261"></a>
<FONT color="green">262</FONT> }<a name="line.262"></a>
<FONT color="green">263</FONT> <a name="line.263"></a>
<FONT color="green">264</FONT> private boolean documentConstructor(ConstructorDoc doc, ClassInfo info) {<a name="line.264"></a>
<FONT color="green">265</FONT> // discard not demanded constructors<a name="line.265"></a>
<FONT color="green">266</FONT> String name = doc.name();<a name="line.266"></a>
<FONT color="green">267</FONT> Member member = getMember(name, info.constructors);<a name="line.267"></a>
<FONT color="green">268</FONT> if (member == null) {<a name="line.268"></a>
<FONT color="green">269</FONT> if (verbose)<a name="line.269"></a>
<FONT color="green">270</FONT> System.err.println("Omitting \"" + doc.toString() + "\".");<a name="line.270"></a>
<FONT color="green">271</FONT> return false;<a name="line.271"></a>
<FONT color="green">272</FONT> }<a name="line.272"></a>
<FONT color="green">273</FONT> // open the constructor: <constructor><a name="line.273"></a>
<FONT color="green">274</FONT> if (!quiet)<a name="line.274"></a>
<FONT color="green">275</FONT> System.err.println("Processing \"" + doc.toString() + "\".");<a name="line.275"></a>
<FONT color="green">276</FONT> // System.out.println("<!-- " + doc.toString() + " -->");<a name="line.276"></a>
<FONT color="green">277</FONT> System.out.println("<constructor>");<a name="line.277"></a>
<FONT color="green">278</FONT> document(doc);<a name="line.278"></a>
<FONT color="green">279</FONT> documentParameters(doc);<a name="line.279"></a>
<FONT color="green">280</FONT> documentExceptions(doc);<a name="line.280"></a>
<FONT color="green">281</FONT> // close the constructor: </class|interface><a name="line.281"></a>
<FONT color="green">282</FONT> System.out.println("</constructor>");<a name="line.282"></a>
<FONT color="green">283</FONT> return true;<a name="line.283"></a>
<FONT color="green">284</FONT> }<a name="line.284"></a>
<FONT color="green">285</FONT> <a name="line.285"></a>
<FONT color="green">286</FONT> private boolean documentMethod(MethodDoc doc, CompoundInfo info) {<a name="line.286"></a>
<FONT color="green">287</FONT> // discard not demanded methods<a name="line.287"></a>
<FONT color="green">288</FONT> String name = doc.name();<a name="line.288"></a>
<FONT color="green">289</FONT> Member member = getMember(name, info.methods);<a name="line.289"></a>
<FONT color="green">290</FONT> if (member == null) {<a name="line.290"></a>
<FONT color="green">291</FONT> if (verbose)<a name="line.291"></a>
<FONT color="green">292</FONT> System.err.println("Omitting \"" + doc.toString() + "\".");<a name="line.292"></a>
<FONT color="green">293</FONT> return false;<a name="line.293"></a>
<FONT color="green">294</FONT> }<a name="line.294"></a>
<FONT color="green">295</FONT> // open the method: <method name="..."><a name="line.295"></a>
<FONT color="green">296</FONT> if (!quiet)<a name="line.296"></a>
<FONT color="green">297</FONT> System.err.println("Processing \"" + doc.toString() + "\".");<a name="line.297"></a>
<FONT color="green">298</FONT> // System.out.println("<!-- " + doc.toString() + " -->");<a name="line.298"></a>
<FONT color="green">299</FONT> System.out.println("<method name=\"" + name + "\">");<a name="line.299"></a>
<FONT color="green">300</FONT> document(doc);<a name="line.300"></a>
<FONT color="green">301</FONT> documentParameters(doc);<a name="line.301"></a>
<FONT color="green">302</FONT> documentReturns(doc);<a name="line.302"></a>
<FONT color="green">303</FONT> documentExceptions(doc);<a name="line.303"></a>
<FONT color="green">304</FONT> // close the method: </class|interface><a name="line.304"></a>
<FONT color="green">305</FONT> System.out.println("</method>");<a name="line.305"></a>
<FONT color="green">306</FONT> return true;<a name="line.306"></a>
<FONT color="green">307</FONT> }<a name="line.307"></a>
<FONT color="green">308</FONT> <a name="line.308"></a>
<FONT color="green">309</FONT> private boolean documentField(FieldDoc doc, CompoundInfo info) {<a name="line.309"></a>
<FONT color="green">310</FONT> // discard not demanded fields<a name="line.310"></a>
<FONT color="green">311</FONT> String name = doc.name();<a name="line.311"></a>
<FONT color="green">312</FONT> Member member = getMember(name, info.fields);<a name="line.312"></a>
<FONT color="green">313</FONT> if (member == null) {<a name="line.313"></a>
<FONT color="green">314</FONT> if (verbose)<a name="line.314"></a>
<FONT color="green">315</FONT> System.err.println("Omitting \"" + doc.toString() + "\".");<a name="line.315"></a>
<FONT color="green">316</FONT> return false;<a name="line.316"></a>
<FONT color="green">317</FONT> }<a name="line.317"></a>
<FONT color="green">318</FONT> // open the field: <field name="..." type="..." [dimension="..."]><a name="line.318"></a>
<FONT color="green">319</FONT> if (verbose)<a name="line.319"></a>
<FONT color="green">320</FONT> System.err.println("Processing \"" + doc.toString() + "\".");<a name="line.320"></a>
<FONT color="green">321</FONT> // System.out.println("<!-- " + doc.toString() + " -->");<a name="line.321"></a>
<FONT color="green">322</FONT> System.out.print("<field name=\"" + name + "\"");<a name="line.322"></a>
<FONT color="green">323</FONT> documentType(doc.type());<a name="line.323"></a>
<FONT color="green">324</FONT> System.out.println(">");<a name="line.324"></a>
<FONT color="green">325</FONT> document(doc);<a name="line.325"></a>
<FONT color="green">326</FONT> // close the field: </class|interface><a name="line.326"></a>
<FONT color="green">327</FONT> System.out.println("</field>");<a name="line.327"></a>
<FONT color="green">328</FONT> return true;<a name="line.328"></a>
<FONT color="green">329</FONT> }<a name="line.329"></a>
<FONT color="green">330</FONT> <a name="line.330"></a>
<FONT color="green">331</FONT> private boolean documentClass(ClassDoc doc) {<a name="line.331"></a>
<FONT color="green">332</FONT> String name = doc.qualifiedTypeName();<a name="line.332"></a>
<FONT color="green">333</FONT> // discard not demanded types<a name="line.333"></a>
<FONT color="green">334</FONT> CompoundInfo info = (CompoundInfo) demanded.get(name);<a name="line.334"></a>
<FONT color="green">335</FONT> if (info == null) {<a name="line.335"></a>
<FONT color="green">336</FONT> if (!quiet)<a name="line.336"></a>
<FONT color="green">337</FONT> System.err.println("Skipping \"" + doc.toString() + "\".");<a name="line.337"></a>
<FONT color="green">338</FONT> return false;<a name="line.338"></a>
<FONT color="green">339</FONT> }<a name="line.339"></a>
<FONT color="green">340</FONT> // open the compound: <class|interface ...><a name="line.340"></a>
<FONT color="green">341</FONT> boolean isinterface = info instanceof InterfaceInfo;<a name="line.341"></a>
<FONT color="green">342</FONT> String kind = isinterface ? "interface" : "class";<a name="line.342"></a>
<FONT color="green">343</FONT> if (!quiet)<a name="line.343"></a>
<FONT color="green">344</FONT> System.err.println("Processing \"" + doc.toString() + "\".");<a name="line.344"></a>
<FONT color="green">345</FONT> // System.out.println("<!-- " + doc.toString() + " -->");<a name="line.345"></a>
<FONT color="green">346</FONT> // fill the compound attributes: type="..."<a name="line.346"></a>
<FONT color="green">347</FONT> System.out.println("<" + kind + " type=\"" + Processor.translateName(name)<a name="line.347"></a>
<FONT color="green">348</FONT> + "\">");<a name="line.348"></a>
<FONT color="green">349</FONT> // insert the documentation of the type<a name="line.349"></a>
<FONT color="green">350</FONT> document(doc);<a name="line.350"></a>
<FONT color="green">351</FONT> // add the documentation for constructors<a name="line.351"></a>
<FONT color="green">352</FONT> if (!isinterface) {<a name="line.352"></a>
<FONT color="green">353</FONT> ConstructorDoc[] constructors = doc.constructors();<a name="line.353"></a>
<FONT color="green">354</FONT> for (int i = 0; i < constructors.length; ++i)<a name="line.354"></a>
<FONT color="green">355</FONT> documentConstructor(constructors[i], (ClassInfo) info);<a name="line.355"></a>
<FONT color="green">356</FONT> }<a name="line.356"></a>
<FONT color="green">357</FONT> // add the documentation for methods<a name="line.357"></a>
<FONT color="green">358</FONT> MethodDoc[] methods = doc.methods();<a name="line.358"></a>
<FONT color="green">359</FONT> for (int i = 0; i < methods.length; ++i)<a name="line.359"></a>
<FONT color="green">360</FONT> documentMethod(methods[i], info);<a name="line.360"></a>
<FONT color="green">361</FONT> // add the documentation for fields<a name="line.361"></a>
<FONT color="green">362</FONT> FieldDoc[] fields = doc.fields();<a name="line.362"></a>
<FONT color="green">363</FONT> for (int i = 0; i < fields.length; ++i)<a name="line.363"></a>
<FONT color="green">364</FONT> documentField(fields[i], info);<a name="line.364"></a>
<FONT color="green">365</FONT> // close the compound: </class|interface><a name="line.365"></a>
<FONT color="green">366</FONT> System.out.println("</" + kind + ">");<a name="line.366"></a>
<FONT color="green">367</FONT> System.out.println();<a name="line.367"></a>
<FONT color="green">368</FONT> return true;<a name="line.368"></a>
<FONT color="green">369</FONT> }<a name="line.369"></a>
<FONT color="green">370</FONT> <a name="line.370"></a>
<FONT color="green">371</FONT> private void document(CompoundInfo[] subset, ClassDoc[] all) {<a name="line.371"></a>
<FONT color="green">372</FONT> // protect the object from more usages; after the first one it is a zombie<a name="line.372"></a>
<FONT color="green">373</FONT> if (demanded == null)<a name="line.373"></a>
<FONT color="green">374</FONT> throw new IllegalStateException(<a name="line.374"></a>
<FONT color="green">375</FONT> "Object became unusable after having performed a documentation.");<a name="line.375"></a>
<FONT color="green">376</FONT> // put the required types into a map to search them quickly<a name="line.376"></a>
<FONT color="green">377</FONT> for (int i = 0; i < subset.length; ++i)<a name="line.377"></a>
<FONT color="green">378</FONT> demanded.put(subset[i].clazz.getName(), subset[i]);<a name="line.378"></a>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -