From f197c0c93762a5ba4181182388d210349f2331c4 Mon Sep 17 00:00:00 2001 From: Simon Rozman Date: Mon, 7 Nov 2016 09:26:55 +0100 Subject: [PATCH] Doxygen documentation update --- Doxyfile | 13 +++++++++---- README.md | 12 ++++++------ 2 files changed, 15 insertions(+), 10 deletions(-) diff --git a/Doxyfile b/Doxyfile index 07696cb..f5c6e1e 100644 --- a/Doxyfile +++ b/Doxyfile @@ -51,7 +51,7 @@ PROJECT_BRIEF = "EAP Supplicant for Windows" # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo # to the output directory. -PROJECT_LOGO = +PROJECT_LOGO = include\icon_ui.ico # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is @@ -694,7 +694,7 @@ CITE_BIB_FILES = # messages are off. # The default value is: NO. -QUIET = NO +QUIET = YES # The WARNINGS tag can be used to turn on/off the warning messages that are # generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES @@ -718,7 +718,7 @@ WARN_IF_UNDOCUMENTED = YES # markup commands wrongly. # The default value is: YES. -WARN_IF_DOC_ERROR = NO +WARN_IF_DOC_ERROR = YES # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that # are documented, but have no documentation for their parameters or return @@ -790,11 +790,16 @@ RECURSIVE = YES # run. EXCLUDE = \ + CredWrite\README.md \ EventMonitor\res \ lib\EAPBase_UI\res \ + lib\EapHost_UI\res \ lib\TLS_UI\res \ lib\TTLS_UI\res \ - lib\WinStd + lib\WinStd \ + lib\wxExtend \ + MsiUseFeature\README.md \ + WLANManager\README.md # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded diff --git a/README.md b/README.md index 4d798b7..e4b8acb 100644 --- a/README.md +++ b/README.md @@ -8,22 +8,22 @@ Suite of EAP supplicants for Windows - IEEE 802.1X plug-ins for enterprise netwo - Microsoft Windows Vista or later - Microsoft Visual Studio 2010 SP1 - _msgfmt.exe_ from [gettext](https://www.gnu.org/software/gettext/); - Hint: [Poedit](https://poedit.net/) contains up-to-date binary Win32 compiled gettext-utilities. Install it and add _GettextTools\bin_ folder to path. + Hint: [Poedit](https://poedit.net/) contains up-to-date binary Win32 compiled gettext-utilities. Install it and add `GettextTools\bin` folder to path. - _sed.exe_ and _grep.exe_ -- _MsiDb.Exe_ and other command line utilities for MSI packaging distributed as a part of Microsoft Windows SDK (installed with Visual Studio). Add SDK's _Bin_ folder to path. +- _MsiDb.Exe_ and other command line utilities for MSI packaging distributed as a part of Microsoft Windows SDK (installed with Visual Studio). Add SDK's `Bin` folder to path. ### wxWidgets GÉANTLink is using wxWidgets v3.0.2 static libraries. Unfortunately, only dynamic libraries (DLL) variant is available as a binary download. Therefore static libraries needs to be compiled from [source](https://github.com/wxWidgets/wxWidgets). #### Compiling wxWidgets Win32 static libraries 1. Start _Visual Studio Command Prompt (2010)_ -2. Change working directory to _build\msw_ +2. Change working folder to `build\msw` 3. Run: `nmake /f makefile.vc /ls RUNTIME_LIBS=static SHARED=0` 4. Run: `nmake /f makefile.vc /ls RUNTIME_LIBS=static SHARED=0 BUILD=release` #### Compiling wxWidgets x64 static libraries 1. Start _Visual Studio x64 Cross Tools Command Prompt (2010)_ -2. Change working directory to _build\msw_ +2. Change working folder to `build\msw` 3. Run: `nmake /f makefile.vc /ls RUNTIME_LIBS=static SHARED=0 TARGET_CPU=X64` 4. Run: `nmake /f makefile.vc /ls RUNTIME_LIBS=static SHARED=0 TARGET_CPU=X64 BUILD=release` @@ -75,7 +75,7 @@ Command | Explanation `nmake Clean` | Deletes all intermediate and output files. `nmake Register` | Builds a debug version of project, registers DLLs, and adds Start Menu shortcuts. For testing and development purposes only! Requires elevated command prompt. `nmake Unregister` | Removes Start Menu shortcuts, unregisters DLLs. For testing development purposes only! Requires elevated command prompt. -`nmake Setup` | Builds a release version of project and release MSI setup files. The resulting files can be found in _output\Setup_ folder. -`nmake SetupDebug` | Builds a debug version of project and debug MSI setup files. The resulting files can be found in _output\Setup_ folder. +`nmake Setup` | Builds a release version of project and release MSI setup files. The resulting files can be found in `output\Setup` folder. +`nmake SetupDebug` | Builds a debug version of project and debug MSI setup files. The resulting files can be found in `output\Setup` folder. The `/ls` flag can be appended to the commands above to reduce NMAKE’s verbosity. You can combine multiple targets (i.e. nmake Unregister Clean). Please, see NMAKE reference for further reading.