2013-06-29 5 views
7

मेरे पास एसबीटी के तहत एक स्कैला परियोजना है। मैं इसके लिए एक javadoc उत्पन्न करना चाहता हूं क्योंकि प्रोजेक्ट एपीआई के अधिकांश उपयोगकर्ता जावा डेवलपर्स हैं। क्या यह संभव है?एसबीटी में स्कैला-केवल परियोजना के लिए जावाडोक-स्टाइल दस्तावेज़ कैसे उत्पन्न करें?

उत्तर

4
% sbt doc 

आप (यदि आप एक सरल एसबीटी परियोजना अनेक उप-परियोजनाओं की जरूरत नहीं है कि प्रयोग कर रहे हैं यह सोचते हैं) target/scala-version/api में परिणाम मिलेंगे।

अद्यतन:

प्रयोग से पता चलता है कि एसबीटी के doc आदेश दोनों परियोजना में स्काला और जावा स्रोतों के लिए डॉक्स उत्पन्न करता है।

+3

मैं एसबीटी डॉक स्केला डॉक –

+0

उत्पन्न करता है क्या अंतर है लगता है? यह HTML आपके कोड का वर्णन कर रहा है। –

+0

वहाँ ** आईएस ** ओपी के लिए एक अंतर है, जिन्होंने ** स्कैला ** प्रकार => डाउनवॉटेड के लिए जावाडोक-स्टाइल दस्तावेज रखने के बारे में पूछा। –

6

मुझे लगता है कि जावा जावा पुस्तकालयों में उपयोग किए जाने वाले लोगों से कुछ परिचित होने के लिए आप जावा डॉक प्रारूप में अपने दस्तावेज़ चाहते हैं?

टाइपफेफ से जेनजावाडोक नामक एक प्रोजेक्ट है जो आप खोज रहे हैं। यह एक प्रारूप में स्केल लाइब्रेरी के लिए दस्तावेज़ बनाता है जो जावाडॉक के समान है। इसे एक एसबीटी निर्माण में एकीकृत किया जा सकता है।

अक्का के पास एक बहुत ही पूर्ण जावा एपीआई है, और अक्का के कई उपयोगकर्ता जावा दुनिया से आते हैं, इसलिए जाहिर है कि उन्हें इसकी आवश्यकता है।

The project repository

Akka japi docs generated by the tool

Blog post by Roland Kuhn describing the tool and the rationale

संबंधित मुद्दे