Merge pull request #6677 from symless/issue-6666-doxygen-documentation

Created Doxygen documentation
This commit is contained in:
Jnewbon 2020-04-30 10:48:52 +01:00 committed by GitHub
commit 35dee25402
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 2536 additions and 1 deletions

2
.gitignore vendored
View file

@ -21,6 +21,8 @@ src/gui/.rnd
src/setup/win32/synergy.suo
/.idea
/cmake-build-debug
/cmake-build-release/
/CMakeLists.txt.user
/.vs
/CMakeLists.txt.*
/doxygen/

2494
Doxyfile Normal file

File diff suppressed because it is too large Load diff

View file

@ -26,3 +26,4 @@ Not for the faint hearted. Only use these if you know what you're doing.
* [Translations](https://crowdin.com/project/synergy-core) - If you want to submit translations to the Synergy Core.
* [Text Config](https://github.com/symless/synergy-core/wiki/Text-Config) - Write a text config file when running Synergy Core manually.
* [Command Line](https://github.com/symless/synergy-core/wiki/Command-Line) - Go full manual and run Synergy Core from the command line.
* [Doxygen Documentation](https://docs.symless.com/synergy-core/) - Doxygen documentation.

View file

@ -244,4 +244,42 @@ jobs:
configuration: 'Release'
msbuildArguments: '/m'
maximumCpuCount: true
displayName: 'Compiling x86'
displayName: 'Compiling x86'
- job: DoxygenDoc
condition: eq(variables['Build.SourceBranch'], 'refs/heads/master')
pool:
vmImage: 'ubuntu-16.04'
steps:
- script: |
sudo DEBIAN_FRONTEND=noninteractive
sudo apt-get -y update
sudo apt-get -y install doxygen graphviz
displayName: 'Install Pakages'
- script: |
doxygen Doxyfile
cd doxygen
tar -czvf ../docs.tar.gz ./*
displayName: 'Generate Docs'
- task: CopyFilesOverSSH@0
inputs:
sshEndpoint: 'Azure on Sandor'
sourceFolder: '.'
contents: 'docs.tar.gz'
targetFolder: 'synergy-core'
readyTimeout: '20000'
displayName: 'Publish files to sandor'
- task: SSH@0
inputs:
sshEndpoint: 'Azure on Sandor'
runOptions: 'commands'
commands: |
tar -C ./synergy-core/docs -xzvf ./synergy-core/docs.tar.gz --overwrite
readyTimeout: '20000'
displayName: 'Extract files on sandor'