This is an automated email from the ASF dual-hosted git repository.
aharui pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/royale-asjs.wiki.git
The following commit(s) were added to refs/heads/master by this push:
new a565bdf Created Generating an API Report (markdown)
a565bdf is described below
commit a565bdf28f87ae81788c51f3c362575a46c38374
Author: aharui <[email protected]>
AuthorDate: Wed Apr 18 16:10:32 2018 -0700
Created Generating an API Report (markdown)
---
Generating-an-API-Report.md | 17 +++++++++++++++++
1 file changed, 17 insertions(+)
diff --git a/Generating-an-API-Report.md b/Generating-an-API-Report.md
new file mode 100644
index 0000000..c758188
--- /dev/null
+++ b/Generating-an-API-Report.md
@@ -0,0 +1,17 @@
+The Royale compiler can generate a list of APIs used by an application. This
is helpful in determining the optimal migration strategy and effort.
+
+To generate an API Report for your application, it is best if you can build
your application from the command line. So you may need to determine the
compiler options being used by your IDE, or your Maven or Ant configurations.
So step 1 is to use your Flex SDK's mxmlc compiler to successfully build your
application. So from the command line, you might type something like:
+
+```
+<path to Flex SDK>/bin/mxmlc -library-path+=<third-party-library>.swc <path to
main MXML File>/MyApp.mxml
+```
+
+Once you get a successful compile, then download and set up a Royale SDK by
following the instructions on [this
page](https://apache.github.io/royale-docs/Welcome/Get_Started/Download-Royale.html).
Then run the same compiler in the Royale SDK but with the -api-report option,
such as:
+
+```
+<path to Royale SDK>/bin/mxmlc -library-path+=<third-party-library>.swc
-api-report=<file to contain report output> <path to main MXML File>/MyApp.mxml
+```
+
+If you get errors, fix them in your code or comment out that code if it won't
impact the report. The Royale Compiler may find errors that the Flex SDK
compiler did not detect.
+
+Then the file you specified in the -api-report option should contain the
information about your app. If your app as other projects like modules or
libraries (SWCs) then you will need to do the same thing to get API reports for
those projects as well. Use compc instead of mxmlc to compile SWCs.
\ No newline at end of file
--
To stop receiving notification emails like this one, please contact
[email protected].
