Minor documentation adjustments to the demos, projects and bootloaders to ensure...

[pub/USBasp.git] / LUFA / DoxygenPages / ExportingLibrary.txt

diff --git a/LUFA/DoxygenPages/ExportingLibrary.txt b/LUFA/DoxygenPages/ExportingLibrary.txt
index 848c42b..0f45c23 100644 (file)
--- a/LUFA/DoxygenPages/ExportingLibrary.txt
+++ b/LUFA/DoxygenPages/ExportingLibrary.txt
@@ -25,18 +25,18 @@
  *   - DoxygenPages/\r
  *   - CodeTemplates/\r
  *\r
  *   - DoxygenPages/\r
  *   - CodeTemplates/\r
  *\r

- *  If required, files from the CodeTemplates/ subdirectory may be copied to your IDE project as required.\r
+ *  If required, files from the CodeTemplates/ subdirectory may be copied to your IDE project as needed.\r

  *\r
  *  The resulting copy of the library may then be imported into your chosen IDE according to the instructions\r
  *  shown in \ref Sec_LibraryImport.\r
  *\r
  *  \subsection SSec_AutomaticExport Automatic Export\r
  *  If desired, the steps indicated in \ref SSec_ManualExport may be automatically performed, by running the\r
  *\r
  *  The resulting copy of the library may then be imported into your chosen IDE according to the instructions\r
  *  shown in \ref Sec_LibraryImport.\r
  *\r
  *  \subsection SSec_AutomaticExport Automatic Export\r
  *  If desired, the steps indicated in \ref SSec_ManualExport may be automatically performed, by running the\r

- *  command <b><code>make export_tar</code></b> from the command line. This will generate two .TAR files in the\r
- *  current directory, named <b>LUFA_<i>{Version Number}</i>.tar</b> and\r
- *  <b>LUFA_<i>{Version Number}</i>_Code_Templates.tar</b>. The first archive contains the exported LUFA core\r
- *  with the non-required files removed, while the second contains an archived copy of the code template files\r
- *  for the current LUFA version.\r
+ *  command <b><code>make export_tar</code></b> from the command line. This will generate two .tar files in the\r
+ *  current directory, named <code>LUFA_XXXXXX.tar</code> and <code>LUFA_XXXXXX_Code_Templates.tar</code> (where "XXXXXX" is\r
+ *  the version of the library being exported). The first archive contains the exported LUFA core with the\r
+ *  non-required files removed, while the second contains an archived copy of the code template files for the\r
+ *  current LUFA version.\r

  *\r
  *  The resulting archived copy of the library may then be extracted to your chosen IDE project source directory\r
  *  and imported according to the instructions shown in \ref Sec_LibraryImport.\r
  *\r
  *  The resulting archived copy of the library may then be extracted to your chosen IDE project source directory\r
  *  and imported according to the instructions shown in \ref Sec_LibraryImport.\r


@@ -54,21 +54,21 @@
  *  Copy over the exported library archive created via the steps listed in \ref Sec_LibraryExport to your AS5/AS6\r
  *  project directory.\r
  *\r
  *  Copy over the exported library archive created via the steps listed in \ref Sec_LibraryExport to your AS5/AS6\r
  *  project directory.\r
  *\r

- *  \image html Images\AS5_AS6_Import\AS5_AS6_Import_Step1.png\r
+ *  \image html Images/AS5_AS6_Import/AS5_AS6_Import_Step1.png\r

  *\r
  *  \subsubsection SSSec_AS56_Import_Step2 Extract exported library\r
  *  Extract out the contents of the archive to a new folder. This may be any name you wish, however keep in mind\r
  *  that this name will need to be referenced within your user application under most circumstances. It is\r
  *  suggested that this folder be named "LUFA", or "LUFA" followed by the version string for easy reference.\r
  *\r
  *\r
  *  \subsubsection SSSec_AS56_Import_Step2 Extract exported library\r
  *  Extract out the contents of the archive to a new folder. This may be any name you wish, however keep in mind\r
  *  that this name will need to be referenced within your user application under most circumstances. It is\r
  *  suggested that this folder be named "LUFA", or "LUFA" followed by the version string for easy reference.\r
  *\r

- *  \image html Images\AS5_AS6_Import\AS5_AS6_Import_Step2.png\r
+ *  \image html Images/AS5_AS6_Import/AS5_AS6_Import_Step2.png\r

  *\r
  *  \subsubsection SSSec_AS56_Import_Step3 Add the library files\r
  *  Open your AVRStudio 5/Atmel Studio 6 project. From the "Solution Explorer" pane, click the "Show All Files"\r
  *  button on the toolbar to display ghosted icons of files and folders located in the project source directory\r
  *  that are not currently added to the project.\r
  *\r
  *\r
  *  \subsubsection SSSec_AS56_Import_Step3 Add the library files\r
  *  Open your AVRStudio 5/Atmel Studio 6 project. From the "Solution Explorer" pane, click the "Show All Files"\r
  *  button on the toolbar to display ghosted icons of files and folders located in the project source directory\r
  *  that are not currently added to the project.\r
  *\r

- *  \image html Images\AS5_AS6_Import\AS5_AS6_Import_Step3.png\r
+ *  \image html Images/AS5_AS6_Import/AS5_AS6_Import_Step3.png\r

  *\r
  *  Right-click the ghosted version of the extracted LUFA export folder in the Solution Explorer pane, and\r
  *  choose the "Add to Project" option from the context menu. This will add the entire LUFA source tree to the\r
  *\r
  *  Right-click the ghosted version of the extracted LUFA export folder in the Solution Explorer pane, and\r
  *  choose the "Add to Project" option from the context menu. This will add the entire LUFA source tree to the\r


@@ -79,7 +79,7 @@
  *  open the Project Properties window. This window allows you to configure the various project global compiler,\r
  *  assembler and linker options.\r
  *\r
  *  open the Project Properties window. This window allows you to configure the various project global compiler,\r
  *  assembler and linker options.\r
  *\r

- *  \image html Images\AS5_AS6_Import\AS5_AS6_Import_Step4.png\r
+ *  \image html Images/AS5_AS6_Import/AS5_AS6_Import_Step4.png\r

  * \r
  *  Click the "Toolchain" tab on the left side of the Project Properties window.\r
  *\r
  * \r
  *  Click the "Toolchain" tab on the left side of the Project Properties window.\r
  *\r


@@ -94,13 +94,13 @@
  *   - F_CPU\r
  *   - F_USB\r
  *   - BOARD\r
  *   - F_CPU\r
  *   - F_USB\r
  *   - BOARD\r

- *  \image html Images\AS5_AS6_Import\AS5_AS6_Import_Step5_1.png\r
+ *  \image html Images/AS5_AS6_Import/AS5_AS6_Import_Step5_1.png\r

  *\r
  *  Next, open the GNU C Compiler section's "Optimization" page. Ensure that the option to prepare functions for\r
  *  garbage collection is enabled.\r
  *\r
  *  Next, open the GNU C Compiler section's "Optimization" page. Ensure that the option to prepare functions for\r
  *  garbage collection is enabled.\r

- *  \image html Images\AS5_AS6_Import\AS5_AS6_Import_Step5_2.png\r
+ *  \image html Images/AS5_AS6_Import/AS5_AS6_Import_Step5_2.png\r

  *\r
  *  Finally, in the GNU C Linker section, open the "Optimization" page. Ensure that the option to garbage collect\r
  *  unused sections is selected.\r
  *\r
  *  Finally, in the GNU C Linker section, open the "Optimization" page. Ensure that the option to garbage collect\r
  *  unused sections is selected.\r

- *  \image html Images\AS5_AS6_Import\AS5_AS6_Import_Step5_3.png\r
+ *  \image html Images/AS5_AS6_Import/AS5_AS6_Import_Step5_3.png\r

  */\r
  */\r