Skip to content

Commit

Permalink
update latest reference guide
Browse files Browse the repository at this point in the history
  • Loading branch information
gammasoft71 committed Sep 12, 2023
1 parent b311eff commit ef4240e
Show file tree
Hide file tree
Showing 9,438 changed files with 1,487,754 additions and 0 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
176 changes: 176 additions & 0 deletions static/reference_guides/latest/html/_c_make_build_option.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,176 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>xtd: CMake build options</title>
<link href="favicon.png" rel="shortcut icon" type="image/png"/>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="custom_images.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
<script type="text/javascript"> DoxygenAwesomeDarkModeToggle.init() </script>
</head>
<body>
<div id="page_container">
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0" style="width: 100%;">
<tbody>
<tr>
<td id="projectlogo">
<a href="https://gammasoft71.github.io/xtd/" target="_new">
<img alt="Logo" src="xtd_doxygen.png"/>
</a>
</td>
<td id="projectalign" style="padding-left: 0.5em; text-align: right;">
<div id="projectname">xtd
<span id="projectnumber">0.2.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.7 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

</div><!-- top -->
<div><div class="header">
<div class="headertitle"><div class="title">CMake build options</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Contains xtd CMake build options.</p>
<dl class="section remark"><dt>Remarks</dt><dd>These options are only needed if you are not using the <a href="https://gammasoft71.github.io/xtd/docs/downloads">installation</a> and want a custom build.</dd></dl>
<h1><a class="anchor" id="xtdBuildOptions"></a>
xtd build options</h1>
<table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadNone">Option Name </th><th class="markdownTableHeadNone">Type </th><th class="markdownTableHeadNone">Description </th><th class="markdownTableHeadNone">Default Value </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">XTD_BUILD_CPP_STANDARD </td><td class="markdownTableBodyNone">string </td><td class="markdownTableBodyNone">Choose c++ standard to build xtd projects (20 17 14 11 compiler_default) </td><td class="markdownTableBodyNone">20 </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">XTD_BUILD_LIBRARIES_XTD_CORE </td><td class="markdownTableBodyNone">bool </td><td class="markdownTableBodyNone">Build xtd.core libraries </td><td class="markdownTableBodyNone">ON </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">XTD_BUILD_LIBRARIES_XTD_DRAWING </td><td class="markdownTableBodyNone">bool </td><td class="markdownTableBodyNone">Build <a class="el" href="namespacextd_1_1drawing.html" title="The xtd::drawing namespace provides access to GDI+ basic graphics functionality. More advanced functi...">xtd.drawing</a> libraries </td><td class="markdownTableBodyNone">ON </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">XTD_BUILD_LIBRARIES_XTD_FORMS </td><td class="markdownTableBodyNone">bool </td><td class="markdownTableBodyNone">Build <a class="el" href="namespacextd_1_1forms.html" title="The xtd::forms namespace contains classes for creating Windows-based applications that take full adva...">xtd.forms</a> libraries </td><td class="markdownTableBodyNone">ON </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">XTD_BUILD_LIBRARIES_XTD_TUNIT </td><td class="markdownTableBodyNone">bool </td><td class="markdownTableBodyNone">Build <a class="el" href="namespacextd_1_1tunit.html" title="The tunit namespace contains a unit test library.">xtd.tunit</a> libraries </td><td class="markdownTableBodyNone">ON </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">XTD_BUILD_SHARED_LIBRARIES </td><td class="markdownTableBodyNone">bool </td><td class="markdownTableBodyNone">Build shared libraries </td><td class="markdownTableBodyNone">OFF </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">XTD_BUILD_TESTS_XTD_CORE </td><td class="markdownTableBodyNone">bool </td><td class="markdownTableBodyNone">Build xtd.core tests </td><td class="markdownTableBodyNone">OFF </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">XTD_BUILD_TESTS_XTD_DRAWING </td><td class="markdownTableBodyNone">bool </td><td class="markdownTableBodyNone">Build <a class="el" href="namespacextd_1_1drawing.html" title="The xtd::drawing namespace provides access to GDI+ basic graphics functionality. More advanced functi...">xtd.drawing</a> tests </td><td class="markdownTableBodyNone">OFF </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">XTD_BUILD_TESTS_XTD_FORMS </td><td class="markdownTableBodyNone">bool </td><td class="markdownTableBodyNone">Build <a class="el" href="namespacextd_1_1forms.html" title="The xtd::forms namespace contains classes for creating Windows-based applications that take full adva...">xtd.forms</a> tests </td><td class="markdownTableBodyNone">OFF </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">XTD_BUILD_TESTS_XTD_TUNIT </td><td class="markdownTableBodyNone">bool </td><td class="markdownTableBodyNone">Build <a class="el" href="namespacextd_1_1tunit.html" title="The tunit namespace contains a unit test library.">xtd.tunit</a> tests </td><td class="markdownTableBodyNone">OFF </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">XTD_BUILD_TOOL_GUIDGEN_COMMAND_LINE </td><td class="markdownTableBodyNone">bool </td><td class="markdownTableBodyNone">Build tool guidgen command line </td><td class="markdownTableBodyNone">ON </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">XTD_BUILD_TOOL_GUIDGEN_GUI </td><td class="markdownTableBodyNone">bool </td><td class="markdownTableBodyNone">Build tool guidgen GUI </td><td class="markdownTableBodyNone">ON </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">XTD_BUILD_TOOL_SLEEPFOR_COMMAND_LINE </td><td class="markdownTableBodyNone">bool </td><td class="markdownTableBodyNone">Build tool sleepfor command line </td><td class="markdownTableBodyNone">ON </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">XTD_BUILD_TOOL_XTDC_COMMAND_LINE </td><td class="markdownTableBodyNone">bool </td><td class="markdownTableBodyNone">Build tool xtdc command line </td><td class="markdownTableBodyNone">ON </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">XTD_BUILD_TOOL_XTDC_GUI </td><td class="markdownTableBodyNone">bool </td><td class="markdownTableBodyNone">Build tool xtdc GUI </td><td class="markdownTableBodyNone">ON </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">XTD_DOWNLOAD_DOXYGEN </td><td class="markdownTableBodyNone">bool </td><td class="markdownTableBodyNone">Download and build doxygen from Github </td><td class="markdownTableBodyNone">OFF </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">XTD_ENABLE_COMMAND_REFERENCE_GUIDE_GENERATOR </td><td class="markdownTableBodyNone">bool </td><td class="markdownTableBodyNone">Enable command Reference Guide Generator </td><td class="markdownTableBodyNone">OFF </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">XTD_ENABLE_COVERAGE </td><td class="markdownTableBodyNone">bool </td><td class="markdownTableBodyNone">Enable code coverage </td><td class="markdownTableBodyNone">OFF </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">XTD_INSTALL_EXAMPLES </td><td class="markdownTableBodyNone">bool </td><td class="markdownTableBodyNone">Install examples </td><td class="markdownTableBodyNone">ON </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">XTD_INSTALL_RESOURCES </td><td class="markdownTableBodyNone">bool </td><td class="markdownTableBodyNone">Install resources </td><td class="markdownTableBodyNone">ON </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">XTD_NATIVE_GRAPHIC_TOOLKIT </td><td class="markdownTableBodyNone">string </td><td class="markdownTableBodyNone">Choose toolkit for native drawing and forms libraries <em>(see note 1)</em> </td><td class="markdownTableBodyNone">wxwidgets </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">XTD_NATIVE_OPERATING_SYSTEM </td><td class="markdownTableBodyNone">string </td><td class="markdownTableBodyNone">Choose Operating System for native system libraries (Windows macOS linux iOS android) </td><td class="markdownTableBodyNone">The current host OS </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">XTD_SET_COMPILER_OPTION_WARNINGS_AS_ERRORS </td><td class="markdownTableBodyNone">bool </td><td class="markdownTableBodyNone">Enable compiler option warnings as errors </td><td class="markdownTableBodyNone">ON </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">XTD_SET_COMPILER_OPTION_WARNINGS_TO_ALL </td><td class="markdownTableBodyNone">bool </td><td class="markdownTableBodyNone">Enable compiler option warnings to all </td><td class="markdownTableBodyNone">ON </td></tr>
</table>
<p><em>(note 1)</em> The list of the underlying graphic toolkit depends of the operating system :</p><ul>
<li>Windows : msw wxwidgets qt5 fltk</li>
<li>macOS : cocoa wxwidgets qt5 fltk</li>
<li>linux : gtk4 gtk3 wxwidgets qt5 fltk</li>
</ul>
<dl class="section remark"><dt>Remarks</dt><dd>xtd use only wxwigets underlying toolkits for all platform. But in the future xtd will use specific toolkit by platform :<ul>
<li>Windows : msw</li>
<li>macOS : cocoa</li>
<li>linux : gtk4</li>
</ul>
</dd></dl>
<h1><a class="anchor" id="xtUserProjectdBuildOptions"></a>
xtd user project build options</h1>
<table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadNone">Option Name </th><th class="markdownTableHeadNone">Type </th><th class="markdownTableHeadNone">Description </th><th class="markdownTableHeadNone">Default Value </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">XTD_BUILD_CPP_STANDARD </td><td class="markdownTableBodyNone">string </td><td class="markdownTableBodyNone">Choose c++ standard to build xtd projects (20 17 14 11 compiler_default) </td><td class="markdownTableBodyNone">20 </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">XTD_DOWNLOAD_DOXYGEN </td><td class="markdownTableBodyNone">bool </td><td class="markdownTableBodyNone">Download and build doxygen from Github </td><td class="markdownTableBodyNone">OFF </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">XTD_ENABLE_COMMAND_REFERENCE_GUIDE_GENERATOR </td><td class="markdownTableBodyNone">bool </td><td class="markdownTableBodyNone">Enable command Reference Guide Generator </td><td class="markdownTableBodyNone">ON </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">XTD_SET_COMPILER_OPTION_WARNINGS_AS_ERRORS </td><td class="markdownTableBodyNone">bool </td><td class="markdownTableBodyNone">Enable compiler option warnings as errors </td><td class="markdownTableBodyNone">OFF </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">XTD_SET_COMPILER_OPTION_WARNINGS_TO_ALL </td><td class="markdownTableBodyNone">bool </td><td class="markdownTableBodyNone">Enable compiler option warnings to all </td><td class="markdownTableBodyNone">ON </td></tr>
</table>
</div></div><!-- contents -->
</div><!-- PageDoc -->
<!-- HTML footer for doxygen 1.9.1-->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 12 2023 20:40:26 for xtd by <a href="https://gammasoft71.wixsite.com/gammasoft">Gammasoft</a>. All rights reserved.
</small></address>
</body>
</html>
Loading

0 comments on commit ef4240e

Please sign in to comment.