Wed, 02 May 2018 18:42:04 +0200
doc: MWE for ucx_stream_copy()
256
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
1 | # |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
2 | # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
3 | # |
259 | 4 | # Copyright 2017 Mike Becker, Olaf Wintermann All rights reserved. |
256
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
5 | # |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
6 | # Redistribution and use in source and binary forms, with or without |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
7 | # modification, are permitted provided that the following conditions are met: |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
8 | # |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
9 | # 1. Redistributions of source code must retain the above copyright |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
10 | # notice, this list of conditions and the following disclaimer. |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
11 | # |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
12 | # 2. Redistributions in binary form must reproduce the above copyright |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
13 | # notice, this list of conditions and the following disclaimer in the |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
14 | # documentation and/or other materials provided with the distribution. |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
15 | # |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
16 | # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
17 | # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
18 | # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
19 | # ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
20 | # LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
21 | # CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
22 | # SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
23 | # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
24 | # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
25 | # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
26 | # POSSIBILITY OF SUCH DAMAGE. |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
27 | # |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
28 | |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
29 | PD=pandoc |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
30 | PFLAGS=-c ucx.css -B header.html -A footer.html -T 'UAP Common Extensions' |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
31 | |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
32 | SRC = index.md |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
33 | SRC += install.md |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
34 | SRC += license.md |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
35 | SRC += modules.md |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
36 | |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
37 | DEST = ../web |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
38 | |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
39 | PROJROOT = ../.. |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
40 | LOGO = uaplogo.png |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
41 | |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
42 | HTML = $(SRC:%.md=$(DEST)/%.html) |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
43 | |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
44 | all: html api |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
45 | |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
46 | |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
47 | html: $(DEST) $(DEST)/ucx.css $(DEST)/$(LOGO) $(HTML) |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
48 | |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
49 | |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
50 | api: $(DEST) |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
51 | cd $(PROJROOT); doxygen |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
52 | |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
53 | $(DEST): |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
54 | mkdir -p $@ |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
55 | |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
56 | $(DEST)/%.html: %.md |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
57 | $(PD) $(PFLAGS) $< -o $@ |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
58 | |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
59 | $(DEST)/ucx.css: ucx.css |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
60 | cp $< $@ |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
61 | |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
62 | $(DEST)/$(LOGO): $(PROJROOT)/$(LOGO) |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
63 | cp $< $@ |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
64 | |
2c21b42cf11d
documentation will now be generated using pandoc
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
65 | clean: |
268
00e88487a654
removes man dir from clean target of doc makefile
Mike Becker <universe@uap-core.de>
parents:
267
diff
changeset
|
66 | rm -Rf $(DEST) |