[ruFlash] ASDoc - мой кошмар
virtualmaestro
Уже второй день провел за тем что пытаюсь сгенерироваться документацию
по коду. Облазил все что только смог, уже схожу с ума :) , помогите.
Есть проект к которому подключены три внешних источника сорцов -
PureMVC, Papervision, и классы юзер интерфейса FlashIDE - ..ActionScript
3.0\User Interface\..
Ввожу следующую конструкцию в консоль:
"C:\Program Files\Adobe\FLEX SDK\3.5\bin\asdoc.exe" -output "E:\docum"
-source-path "E:\workspace\MyProject\src" -doc-classes .
-exclude-dependencies=true
Вылетает ошибка:
Error: could not find source for class ..
Уже много разных вариаций перепробовал - с параметром doc-classes и
экранировал точку и слеши дописывал. А когда задал конкретно один класс
(в этом классе есть связь с классами PureMVC) так он выдал:
public class ApplicationFacade extends Facade implements IFacade
^
E:\workspace\MyProject\src\com\ApplicationFacade.as(13): col: 59 Error:
LэЄхЁЇхщё IFacade эх эрщфхэ.
public class ApplicationFacade extends Facade implements IFacade
^
E:\workspace\MyProject\src\com\ApplicationFacade.as(33): col: 31 Error:
¦хЄюф, ъюЄюЁvщ яюьхўхэ эр яхЁхюяЁхфхыхэшх, фюы
цхэ яхЁхюяЁхфхы Є№ фЁєующ ьхЄюф.
override protected function initializeController():void
^
(Там я не ошибся- он вывел иероглифы - это еще один подвопрос - как
сделать чтобы эта тулза выводила нормальную кодировку)
Вроде стоит ключ exclude-dependencies но он все равно что то говорит на
внешние сорцы.
Может еще что нибудь в параметре doc-classes надо поменять, но только
так чтобы он сам хавал все классы, а не чтобы ему все несколько сот
вручную забивать.
Может кто имел проблемы с этой тулзой научите неуча как пользоваться ей.
(Гугл не предлагать - за два дня я ему надоел со своими запросами на эту
тему ).
Заранее благодарю.
--
отменить подписку: ruFlash-u...@googlegroups.com
сообщение в группу: ruF...@googlegroups.com
страница группы: http://groups.google.com/group/ruFlash
правила группы: http://groups.google.com/group/ruFlash/web/rules
Рост
Работа с ASDoc обстоит совершенно неказуально -- в том смысле, что
начинающему разобраться без посторонней помощи довольно сложно. Или
как повезет. Но хотелось бы чтобы получилось хоть что-нибудь, для
начала, чтобы "билд прошел". Я тоже как-то потратил зря день на первое
знакомство, а теперь, знаю с чего лучше начать, чтобы не тратить
лишнее время.
Можно начать с работающих и отлаженных примеров. Например, собрать
документацию к классам, идущим в составе Flex SDK. К ним прилагается
готовый конфиг для сборки этих классов с помощью Ant ASDoc Task. Это
такая утилита-обертка вокруг ASDoc tool, позволюящая вынести опции
сборки доки в удобочитаемый файл build.xml и затем с помощью утилиты
Apache Ant выполнить сборку через ASDoc.
Короче, чтобы не терять кучу времени на конфигурацию, рекомендую
начать с файла "c:\Program Files\Adobe\Adobe Flash Builder 4\sdks
\4.0.0\asdoc\build.xml", очень экономит усилия (в любом Flex SDK
нужный билд-файл находится по относительному адрему "[FLEX_SDK_DIR]
\asdoc\build.xml")
Собрать доку с этим билд-файлом от Adobe ты сможешь с первого раза,
при наличии на машине Apache Ant (http://ant.apache.org ).
После этого просто возьми данный конфиг и переделай под свой проект.
Это будет легче, чем начинать с чистого листа. Постепенно поймешь, что
нужно отрезать, а что - добавить.
virtualmaestro
Надеюсь теперь разберусь :)
virtualmaestro
(при чем с разными подходами) собирать проект только сегодня и это не
может не радовать (или расстраивать ?)
Но все же не могу сделать одну штуку, если кто сталкивался отпишите
пожалуйста.
Возьмем вариант синтаксиса для ASDoc Task. Есть следующие строки:
<compiler.source-path
path-element="E:\workspace\ExampleBox2D\src"/>
<compiler.source-path path-element="D:\Deadman\Game
development (resources)\Physics\bin\Box2DFlashAS3_2.0.2_"/>
<doc-sources path-element="E:\workspace\ExampleBox2D\src" />
<doc-sources path-element="D:\Deadman\Game development
(resources)\Physics\bin\Box2DFlashAS3_2.0.2_" />
<exclude-sources path-element="D:\Deadman\Game development
(resources)\Physics\bin\Box2DFlashAS3_2.0.2_\Box2D"/>
Тут вроде все понятно - есть проект и к нему подключены исходники
библиотеки (в данном случае Box2D), потому в source-path и в doc-sources
указываем оба путя к исходникам.
Только вот в документацию надо включить только классы проекта, а классы
библиотеки не включать. Потому я пишу пятую строку exclude-sources и
исключаю путь с библиотекой.
И вопрос в том что эту пятую строчку он как бы игнорирует - в
документацию все равно включает классы библиотеки.
Кто знает почему и как сделать так чтобы не включало? (Может как то не
правильно использована директива exclude-sources ?)
P.S. Сразу скажу что можно через exclude-classes (и оно работает -
проверено), но там надо вручную указывать все классы, а это согласитесь
геморой, если какая то библиотека будет иметь 1000 классов то надо будет
все вручную прописывать - не вариант.
Doomer SamoilOFF
В свое время я легко генерил доку, используя flashdevelop. Там есть утилита Documentation Generator.
--
Faithfully yours
Samoiloff
_______________
http://samoiloff.com/
makc
On May 24, 5:45 pm, Doomer SamoilOFF <doomer.samoil...@gmail.com>
wrote:
> В свое время я легко генерил доку, используя flashdevelop. Там есть утилита
> Documentation Generator.
да, до сих пор есть, и отлично работает.
меню->Tools->Flash Tools->Documentation Generator
virtualmaestro
для ASDoc ?
Кстати, для ASDoc так и не смог исключить из документации внешние
сорсники (целым пакетом), которые были подключены к проекту :( .
Только если вручную все классы перебрать. Конечно, если их 10 то это не
проблема, а если несколько сот...
makc
> Спасибо, не знал. А там такие же правила оформления комментариев как и
> для ASDoc ?
это как бы и есть асдок, спрятанный под графическим интерфейсом