JZJ
/
anslatortray
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 8 Wiki Activity

add more documentation

Browse Source
compileTime
John Jekel 5 years ago
parent 720d3bf247
commit b1082e5cb8
13 changed files with 48 additions and 28 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 2
      docs/doxygen/anslatortray_8hpp.html
  2. 28
      docs/doxygen/anslatortray_8hpp_source.html
  3. 2
      docs/doxygen/dir_d44c64559bbebec7f509842c48db8b23.html
  4. 2
      docs/doxygen/files.html
  5. 7
      docs/doxygen/index.html
  6. 2
      docs/doxygen/namespaceanslatortray.html
  7. 2
      docs/doxygen/namespaceanslatortray_1_1_characters.html
  8. 2
      docs/doxygen/namespaceanslatortray_1_1_characters_1_1_letters.html
  9. 2
      docs/doxygen/namespacemembers.html
  10. 2
      docs/doxygen/namespacemembers_func.html
  11. 2
      docs/doxygen/namespacemembers_vars.html
  12. 2
      docs/doxygen/namespaces.html
  13. 21
      include/anslatortray.hpp

2
docs/doxygen/anslatortray_8hpp.html
Unescape View File

@ -153,7 +153,7 @@ Variables</h2></td></tr>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="anslatortray_8hpp.html">anslatortray.hpp</a></li>
<li class="footer">Generated on Sat Dec 29 2018 10:39:24 for Anslatortray by
<li class="footer">Generated on Sat Dec 29 2018 11:03:42 for Anslatortray by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>

28
docs/doxygen/anslatortray_8hpp_source.html
View File

File diff suppressed because one or more lines are too long

2
docs/doxygen/dir_d44c64559bbebec7f509842c48db8b23.html
Unescape View File

@ -95,7 +95,7 @@ Files</h2></td></tr>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li>
<li class="footer">Generated on Sat Dec 29 2018 10:39:24 for Anslatortray by
<li class="footer">Generated on Sat Dec 29 2018 11:03:42 for Anslatortray by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>

2
docs/doxygen/files.html
Unescape View File

@ -93,7 +93,7 @@ $(document).ready(function(){initNavTree('files.html','');});
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Sat Dec 29 2018 10:39:24 for Anslatortray by
<li class="footer">Generated on Sat Dec 29 2018 11:03:42 for Anslatortray by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>

7
docs/doxygen/index.html
Unescape View File

@ -88,7 +88,10 @@ Anslatortray 0.3.1</h1>
<p>Welcome to the Anslatortray Documentation!</p>
<p>A simple, header-only library to translate from English to Pig Latin.</p>
<p><a href="https://github.com/JZJisawesome/anslatortray">Anslatortray Github Repository</a>.</p>
<h3>Anslatortray Licence </h3>
<p><a href="hhttps://en.wikipedia.org/wiki/Pig_Latin">Wikipedia's definition</a> of Pig Latin is "a language game in which words in English are altered, usually by adding a fabricated suffix or by moving the onset or initial consonant or consonant cluster of a word to the end of the word and adding a vocalic syllable to create such a suffix."</p>
<p>Essentially, the word is reorganized in an effort to hide its true meaning, which can be lots of fun! The Anslatortray library can help out by converting any English text into Pig Latin quickly and easily</p>
<p>Try compiling this example code (with C++11)</p>
<div class="fragment"><div class="line"><span class="preprocessor">#include &quot;<a class="code" href="anslatortray_8hpp.html">anslatortray.hpp</a>&quot;</span></div><div class="line"><span class="preprocessor">#include &lt;iostream&gt;</span></div><div class="line"></div><div class="line"><span class="keywordtype">void</span> main()</div><div class="line">{</div><div class="line"> std::cout &lt;&lt; <a class="code" href="namespaceanslatortray.html#a84b01c945c94064490129166041f610e">anslatortray::translate</a>(<span class="stringliteral">&quot;Hello World!&quot;</span>) &lt;&lt; std::endl;</div><div class="line"> <span class="keywordflow">return</span> 0;</div><div class="line">}</div></div><!-- fragment --><h3>Anslatortray Licence </h3>
<p>MIT License</p>
<p>Copyright (c) 2018 John Jekel</p>
<p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p>
@ -102,7 +105,7 @@ Anslatortray 0.3.1</h1>
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Sat Dec 29 2018 10:39:24 for Anslatortray by
<li class="footer">Generated on Sat Dec 29 2018 11:03:42 for Anslatortray by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>

2
docs/doxygen/namespaceanslatortray.html
Unescape View File

@ -389,7 +389,7 @@ Imperfect results with plural words (ending in "s") and words with mutiple posse
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceanslatortray.html">anslatortray</a></li>
<li class="footer">Generated on Sat Dec 29 2018 10:39:24 for Anslatortray by
<li class="footer">Generated on Sat Dec 29 2018 11:03:42 for Anslatortray by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>

2
docs/doxygen/namespaceanslatortray_1_1_characters.html
Unescape View File

@ -146,7 +146,7 @@ Variables</h2></td></tr>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceanslatortray.html">anslatortray</a></li><li class="navelem"><a class="el" href="namespaceanslatortray_1_1_characters.html">Characters</a></li>
<li class="footer">Generated on Sat Dec 29 2018 10:39:24 for Anslatortray by
<li class="footer">Generated on Sat Dec 29 2018 11:03:42 for Anslatortray by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>

2
docs/doxygen/namespaceanslatortray_1_1_characters_1_1_letters.html
Unescape View File

@ -177,7 +177,7 @@ Variables</h2></td></tr>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceanslatortray.html">anslatortray</a></li><li class="navelem"><a class="el" href="namespaceanslatortray_1_1_characters.html">Characters</a></li><li class="navelem"><a class="el" href="namespaceanslatortray_1_1_characters_1_1_letters.html">Letters</a></li>
<li class="footer">Generated on Sat Dec 29 2018 10:39:24 for Anslatortray by
<li class="footer">Generated on Sat Dec 29 2018 11:03:42 for Anslatortray by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>

2
docs/doxygen/namespacemembers.html
Unescape View File

@ -125,7 +125,7 @@ $(document).ready(function(){initNavTree('namespacemembers.html','');});
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Sat Dec 29 2018 10:39:24 for Anslatortray by
<li class="footer">Generated on Sat Dec 29 2018 11:03:42 for Anslatortray by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>

2
docs/doxygen/namespacemembers_func.html
Unescape View File

@ -104,7 +104,7 @@ $(document).ready(function(){initNavTree('namespacemembers_func.html','');});
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Sat Dec 29 2018 10:39:24 for Anslatortray by
<li class="footer">Generated on Sat Dec 29 2018 11:03:42 for Anslatortray by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>

2
docs/doxygen/namespacemembers_vars.html
Unescape View File

@ -107,7 +107,7 @@ $(document).ready(function(){initNavTree('namespacemembers_vars.html','');});
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Sat Dec 29 2018 10:39:24 for Anslatortray by
<li class="footer">Generated on Sat Dec 29 2018 11:03:42 for Anslatortray by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>

2
docs/doxygen/namespaces.html
Unescape View File

@ -95,7 +95,7 @@ $(document).ready(function(){initNavTree('namespaces.html','');});
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Sat Dec 29 2018 10:39:24 for Anslatortray by
<li class="footer">Generated on Sat Dec 29 2018 11:03:42 for Anslatortray by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
</ul>

21
include/anslatortray.hpp
Unescape View File

@ -1,6 +1,6 @@
/** \mainpage
*
* \section welcome_sec Anslatortray 0.3.1
** \section welcome_sec Anslatortray 0.3.1
*
* Welcome to the Anslatortray Documentation!
*
@ -8,9 +8,26 @@
*
* <a href="https://github.com/JZJisawesome/anslatortray">Anslatortray Github Repository</a>.
*
* <a href="hhttps://en.wikipedia.org/wiki/Pig_Latin">Wikipedia's definition</a> of Pig Latin is "a language game in which words in English are altered, usually by adding a fabricated suffix or by moving the onset or initial consonant or consonant cluster of a word to the end of the word and adding a vocalic syllable to create such a suffix."
*
* Essentially, the word is reorganized in an effort to hide its true meaning, which can be lots of fun!
* The Anslatortray library can help out by converting any English text into Pig Latin quickly and easily
*
* <h3> Anslatortray Licence </h3>
* Try compiling this example code (with C++11)
*
* \code
* #include "anslatortray.hpp"
* #include <iostream>
*
* void main()
* {
* std::cout << anslatortray::translate("Hello World!") << std::endl;
* return 0;
* }
* \endcode
*
*
** <h3> Anslatortray Licence </h3>
*
* MIT License
*

Write Preview
Loading…
Cancel
Save