【问题标题】:How to build a SWC with documentation如何使用文档构建 SWC
【发布时间】:2013-10-18 18:41:39
【问题描述】:

更新

  1. 已解决:使用 swc 嵌入文档
  2. 已解决:奇怪的参数名称:param0、param1 等。

我使用compc 创建了一个swc 库。

然后我用asdoc创建了lib doc。

但我不知道如何将它们绑定在一起,因为当我在另一个项目中使用 .swc 时,参数名称很奇怪(如 myMethod(param0:Number))并且没有文档描述。

我正在使用 Ant,这是我的配置文件:

<?xml version="1.0" encoding="utf-8" ?>
<project name="uil" default="compile" basedir=".">

    <property name="flexsdk" location="C:/sdks/flex_sdk_4.6/bin"/>

    <property name="compc" location="${flexsdk}/compc.exe"/>
    <property name="asdoc" location="${flexsdk}/asdoc.exe"/>

    <property name="src" location="../src"/>
    <property name="bin" location="../bin"/>

    <target name="compile" depends="doc">
        <exec executable="${compc}" failonerror="true">
            <arg line="-debug=false" />
            <arg line="-optimize=true" />
            <arg line="-strict=true" />
            <arg line="-locale=en_US" />
            <arg line="-include-sources=${src}" />
            <arg line="-output=${bin}/uil.swc" />
        </exec>
    </target>

    <target name="doc">
        <exec executable="${asdoc}" failonerror="true">
            <arg line="-main-title 'UIL API Documentation'" />
            <arg line="-window-title 'UIL API Documentation'" />
            <arg line="-source-path ${src} -doc-sources ${src}" />
            <arg line="-output ${bin}/uil-asdoc" />
        </exec>
    </target>

</project>

编辑:如何解决

使所有魔法的线条是这样的:

<taskdef resource="flexTasks.tasks" classpath="${FLEX_HOME}/ant/lib/flexTasks.jar" />

然后我将所有&lt;exec&gt; 标签替换为&lt;compc&gt;&lt;asdoc&gt;,一切正常。可以看到整个代码here.

【问题讨论】:

    标签: actionscript-3 apache-flex ant swc asdoc


    【解决方案1】:

    尝试在Starling 框架的build.xml 中使用zip ant 目标:

    <!-- call asdoc to generate dita xml files -->
    <asdoc output="${temp.dir}" lenient="true" failonerror="true" keep-xml="true" skip-xsl="true" fork="true">
      <compiler.source-path path-element="${basedir}/src" />
      <doc-sources path-element="${basedir}/src" />
    </asdoc>
    <!-- update swc with asdoc xml -->
    <zip destfile="${deploy.dir}/${ant.project.name}.swc" update="true">
      <zipfileset dir="${temp.dir}/tempdita" prefix="docs">
        <include name="*.*"/>
        <exclude name="ASDoc_Config.xml" />
        <exclude name="overviews.xml" />
      </zipfileset>
    </zip>
    

    【讨论】:

    • 嵌入,文件变大。但不工作。我在 IDE 中看不到文档,参数名称仍然很奇怪。 :( EDIT nvm,我做错了。现在我有文档工作,现在只有参数名称很奇怪。
    • 我已经在 flex sdk 4.6 上测试了这个示例(来自 starling),并且具有正确的方法描述和参数名称。试试它而不是你的变体,可能使用 lenient 属性会有所帮助。
    • 我完全按照那个例子做了,现在它可以工作了,谢谢。
    • 我想知道没有 ANT 可以做到这一点吗?例如直接使用命令行?
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2012-06-17
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多