From e90b19ef2b56f92e8bf79017a9cc2669e20f2e16 Mon Sep 17 00:00:00 2001 From: Phil Burk Date: Sun, 4 Oct 2020 11:06:03 -0700 Subject: [PATCH] docs: change Assembla links to GitHub Fixes #298 --- doc/src/mainpage.dox | 18 ++++++++++-------- doc/src/tutorial/compile_windows_mingw.dox | 7 +++++-- doc/src/tutorial/tutorial_start.dox | 6 ++++-- 3 files changed, 19 insertions(+), 12 deletions(-) diff --git a/doc/src/mainpage.dox b/doc/src/mainpage.dox index 7a54d32..53e0060 100644 --- a/doc/src/mainpage.dox +++ b/doc/src/mainpage.dox @@ -34,9 +34,9 @@ Documentation for non-portable platform-specific host API extensions - The PortAudio website -- Our mailing list for users and developers
+- Our mailing list for users and developers
-- The PortAudio wiki +- The PortAudio wiki @section developer_resources Developer Resources @@ -44,18 +44,20 @@ Documentation for non-portable platform-specific host API extensions - @ref srcguide @endif -- Our wiki and issue tracking system +- Our repository on GitHub -- Developer guidelines +- Developer guidelines -- Implementation style guidelines - -If you're interested in helping out with PortAudio development we're more than happy for you to be involved. Just drop by the PortAudio mailing list and ask how you can help. Or check out the starter tickets. +- Implementation style guidelines +If you're interested in helping out with PortAudio development we're more than happy for you to be involved. +Just drop by the PortAudio mailing list and ask how you can help. +Or check out these +recommended starter issues. @section older_api_versions Older API Versions This documentation covers the current API version: PortAudio V19, API version 2.0. API 2.0 differs in a number of ways from previous versions (most often encountered in PortAudio V18), please consult the enhancement proposals for details of what was added/changed for V19: http://www.portaudio.com/docs/proposals/index.html -*/ \ No newline at end of file +*/ diff --git a/doc/src/tutorial/compile_windows_mingw.dox b/doc/src/tutorial/compile_windows_mingw.dox index d521b7b..30143dc 100644 --- a/doc/src/tutorial/compile_windows_mingw.dox +++ b/doc/src/tutorial/compile_windows_mingw.dox @@ -3,7 +3,10 @@ @section comp_mingw1 Portaudio for Windows With MinGW -This document contains old or out-of-date information. Please see a draft of new MinGW information on our Wiki: PortAudio Wiki: Notes about building PortAudio with MinGW +This document contains old or out-of-date information. Please see +a draft of new MinGW information on our +Wiki: +PortAudio Wiki: Notes about building PortAudio with MinGW = MinGW/MSYS = @@ -50,4 +53,4 @@ To update your copy or check out a fresh copy of the source Back to the Tutorial: \ref tutorial_start -*/ \ No newline at end of file +*/ diff --git a/doc/src/tutorial/tutorial_start.dox b/doc/src/tutorial/tutorial_start.dox index f920178..42fa4bf 100644 --- a/doc/src/tutorial/tutorial_start.dox +++ b/doc/src/tutorial/tutorial_start.dox @@ -37,7 +37,9 @@ Below are the steps to writing a PortAudio application using the callback techni In addition to this "Callback" architecture, V19 also supports a "Blocking I/O" model which uses read and write calls which may be more familiar to non-audio programmers. Note that at this time, not all APIs support this functionality. -In this tutorial, we'll show how to use the callback architecture to play a sawtooth wave. Much of the tutorial is taken from the file paex_saw.c, which is part of the PortAudio distribution. When you're done with this tutorial, you'll be armed with the basic knowledge you need to write an audio program. If you need more sample code, look in the "examples" and "test" directory of the PortAudio distribution. Another great source of info is the portaudio.h Doxygen page, which documents the entire V19 API. Also see the page for tips on programming PortAudio on the PortAudio wiki. +In this tutorial, we'll show how to use the callback architecture to play a sawtooth wave. Much of the tutorial is taken from the file paex_saw.c, which is part of the PortAudio distribution. When you're done with this tutorial, you'll be armed with the basic knowledge you need to write an audio program. If you need more sample code, look in the "examples" and "test" directory of the PortAudio distribution. Another great source of info is the portaudio.h Doxygen page, which documents the entire V19 API. +Also see the page for tips on programming PortAudio +on the PortAudio wiki. @section tut_start4 Programming Tutorial Contents @@ -56,4 +58,4 @@ Once you have a basic understanding of how to use PortAudio, you might be intere Next: \ref writing_a_callback -*/ \ No newline at end of file +*/ -- 2.43.0