2b0c244d12
- Upgraded doxyfile to latest format - Fixed a bunch of warnings and errors in docstrings that doxygen was complaining about - Added the doxygen-awesome theme to modernize the output - Removed a duplicate screenshot we'd had in the docs folder - Moved the RecastDemo screenshot into the Docs/images folder - Changed the doxygen main page to be the README.md since the dedicated main page file we had was nearly identical but out of date - Added CONTRIBUTING.md so it's part of the generated doxygen output - Removed duplicate license file to avoid confusion - Combined the FAQ with the Recast_api.txt, since the FAQ was essentially just better docs for the members of `rcConfig`
86 lines
3.9 KiB
JavaScript
86 lines
3.9 KiB
JavaScript
/**
|
|
|
|
Doxygen Awesome
|
|
https://github.com/jothepro/doxygen-awesome-css
|
|
|
|
MIT License
|
|
|
|
Copyright (c) 2022 jothepro
|
|
|
|
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:
|
|
|
|
The above copyright notice and this permission notice shall be included in all
|
|
copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
SOFTWARE.
|
|
|
|
*/
|
|
|
|
class DoxygenAwesomeFragmentCopyButton extends HTMLElement {
|
|
constructor() {
|
|
super();
|
|
this.onclick=this.copyContent
|
|
}
|
|
static title = "Copy to clipboard"
|
|
static copyIcon = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24"><path d="M0 0h24v24H0V0z" fill="none"/><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm3 4H8c-1.1 0-2 .9-2 2v14c0 1.1.9 2 2 2h11c1.1 0 2-.9 2-2V7c0-1.1-.9-2-2-2zm0 16H8V7h11v14z"/></svg>`
|
|
static successIcon = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="24" height="24"><path d="M0 0h24v24H0V0z" fill="none"/><path d="M9 16.17L4.83 12l-1.42 1.41L9 19 21 7l-1.41-1.41L9 16.17z"/></svg>`
|
|
static successDuration = 980
|
|
static init() {
|
|
$(function() {
|
|
$(document).ready(function() {
|
|
if(navigator.clipboard) {
|
|
const fragments = document.getElementsByClassName("fragment")
|
|
for(const fragment of fragments) {
|
|
const fragmentWrapper = document.createElement("div")
|
|
fragmentWrapper.className = "doxygen-awesome-fragment-wrapper"
|
|
const fragmentCopyButton = document.createElement("doxygen-awesome-fragment-copy-button")
|
|
fragmentCopyButton.innerHTML = DoxygenAwesomeFragmentCopyButton.copyIcon
|
|
fragmentCopyButton.title = DoxygenAwesomeFragmentCopyButton.title
|
|
|
|
fragment.parentNode.replaceChild(fragmentWrapper, fragment)
|
|
fragmentWrapper.appendChild(fragment)
|
|
fragmentWrapper.appendChild(fragmentCopyButton)
|
|
|
|
}
|
|
}
|
|
})
|
|
})
|
|
}
|
|
|
|
|
|
copyContent() {
|
|
const content = this.previousSibling.cloneNode(true)
|
|
// filter out line number from file listings
|
|
content.querySelectorAll(".lineno, .ttc").forEach((node) => {
|
|
node.remove()
|
|
})
|
|
let textContent = content.textContent
|
|
// remove trailing newlines that appear in file listings
|
|
let numberOfTrailingNewlines = 0
|
|
while(textContent.charAt(textContent.length - (numberOfTrailingNewlines + 1)) == '\n') {
|
|
numberOfTrailingNewlines++;
|
|
}
|
|
textContent = textContent.substring(0, textContent.length - numberOfTrailingNewlines)
|
|
navigator.clipboard.writeText(textContent);
|
|
this.classList.add("success")
|
|
this.innerHTML = DoxygenAwesomeFragmentCopyButton.successIcon
|
|
window.setTimeout(() => {
|
|
this.classList.remove("success")
|
|
this.innerHTML = DoxygenAwesomeFragmentCopyButton.copyIcon
|
|
}, DoxygenAwesomeFragmentCopyButton.successDuration);
|
|
}
|
|
}
|
|
|
|
customElements.define("doxygen-awesome-fragment-copy-button", DoxygenAwesomeFragmentCopyButton)
|