iOS --appledoc的安裝和使用

一、安裝

  1歧蕉、github上下載地址:https://github.com/tomaz/appledoc.git

   2顽腾、下載之后,終端執(zhí)行 cd /users/你的位置/desktop/appledoc 進(jìn)入appledoc文件

   3副砍、終端執(zhí)行 sudo sh install-appledoc.sh 進(jìn)入安裝,安裝成功會有success提示 ?

二庄岖、使用

  1豁翎、在工程里新建一個target,選擇 Other 中的 Aggregate隅忿。


新建Aggregate

2心剥、在新建的target里選擇Build Phases,添加Run Script?


添加Run Script

3、將下面這段代碼復(fù)制到 Run Script里即可背桐,前五個參數(shù)改成你自己的优烧。

```

#appledoc Xcode script

# Start constants

company="abc";? ? //公司名

companyID="com.abc";? ? //公司id

companyURL="http://abc.com";? //公司url

target="iphoneos";? ? //操作系統(tǒng)

#target="macosx";

outputPath="~/desktop/xtmm/document";? ? //存放的位置

# End constants

/usr/local/bin/appledoc \

--project-name "${PROJECT_NAME}" \

--project-company "${company}" \

--company-id "${companyID}" \

--docset-atom-filename "${company}.atom" \

--docset-feed-url "${companyURL}/${company}/%DOCSETATOMFILENAME" \

--docset-package-url "${companyURL}/${company}/%DOCSETPACKAGEFILENAME" \

--docset-fallback-url "${companyURL}/${company}" \

--output "${outputPath}" \

--publish-docset \

--docset-platform-family "${target}" \

--logformat xcode \

--keep-intermediate-files \

--no-repeat-first-par \

--no-warn-invalid-crossref \

--exit-threshold 2 \

"${PROJECT_DIR}"

```

4、選擇創(chuàng)建的這個target,build一下链峭,然后完全退出再重新打開就可以生成文檔了匙隔。

注意:build的時候會報錯 ?Command /bin/sh failed with exit code 2,但是一樣會生成文檔熏版,不知道是bug還是為什么....

原文地址:https://www.cnblogs.com/zhangshan/p/5275520.html

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末纷责,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子撼短,更是在濱河造成了極大的恐慌再膳,老刑警劉巖,帶你破解...
    沈念sama閱讀 218,607評論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件曲横,死亡現(xiàn)場離奇詭異喂柒,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)禾嫉,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,239評論 3 395
  • 文/潘曉璐 我一進(jìn)店門灾杰,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人熙参,你說我怎么就攤上這事艳吠。” “怎么了孽椰?”我有些...
    開封第一講書人閱讀 164,960評論 0 355
  • 文/不壞的土叔 我叫張陵昭娩,是天一觀的道長凛篙。 經(jīng)常有香客問我,道長栏渺,這世上最難降的妖魔是什么呛梆? 我笑而不...
    開封第一講書人閱讀 58,750評論 1 294
  • 正文 為了忘掉前任,我火速辦了婚禮磕诊,結(jié)果婚禮上填物,老公的妹妹穿的比我還像新娘。我一直安慰自己霎终,他們只是感情好滞磺,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,764評論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著神僵,像睡著了一般。 火紅的嫁衣襯著肌膚如雪覆劈。 梳的紋絲不亂的頭發(fā)上保礼,一...
    開封第一講書人閱讀 51,604評論 1 305
  • 那天,我揣著相機(jī)與錄音责语,去河邊找鬼。 笑死,一個胖子當(dāng)著我的面吹牛仔役,可吹牛的內(nèi)容都是我干的间护。 我是一名探鬼主播,決...
    沈念sama閱讀 40,347評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼白筹,長吁一口氣:“原來是場噩夢啊……” “哼智末!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起徒河,我...
    開封第一講書人閱讀 39,253評論 0 276
  • 序言:老撾萬榮一對情侶失蹤系馆,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后顽照,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體由蘑,經(jīng)...
    沈念sama閱讀 45,702評論 1 315
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,893評論 3 336
  • 正文 我和宋清朗相戀三年代兵,在試婚紗的時候發(fā)現(xiàn)自己被綠了尼酿。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,015評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡植影,死狀恐怖裳擎,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情思币,我是刑警寧澤句惯,帶...
    沈念sama閱讀 35,734評論 5 346
  • 正文 年R本政府宣布土辩,位于F島的核電站,受9級特大地震影響抢野,放射性物質(zhì)發(fā)生泄漏拷淘。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,352評論 3 330
  • 文/蒙蒙 一指孤、第九天 我趴在偏房一處隱蔽的房頂上張望启涯。 院中可真熱鬧,春花似錦恃轩、人聲如沸结洼。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,934評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽松忍。三九已至,卻和暖如春筷厘,著一層夾襖步出監(jiān)牢的瞬間鸣峭,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,052評論 1 270
  • 我被黑心中介騙來泰國打工酥艳, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留摊溶,地道東北人。 一個月前我還...
    沈念sama閱讀 48,216評論 3 371
  • 正文 我出身青樓充石,卻偏偏與公主長得像莫换,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子骤铃,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,969評論 2 355