generated from cs130-w21/template
-
Notifications
You must be signed in to change notification settings - Fork 2
/
.jazzy.yaml
455 lines (439 loc) · 10.5 KB
/
.jazzy.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
custom_categories:
- name: App
children:
- DotsApp
- name: Models
children:
- DotsData
- BillObject
- EntryObject
- Authenticator
- menuOption
- colorScehemeDelegate
- name: View Models
children:
- MainData
- name: Views
children:
- mainView
- EntryListView
- BillDetailView
- AddBillView
- EntryDetailView
- CardRowView
- EntryRowView
- MenuView
- name: View components
children:
- HomeBottomView
- HomeNavbarView
- SettleCardView
- CircleView
- EntryItemView
- CardItem
- NotificationBubble
- dotView
- name: Visual Effects
children:
- BlurBackground
- NavigationBarModifier
- BlurBackgroundView
- name: Global Variables
children:
- classic
- dotColors
- screen
- name: Enumerations
children:
- FilterType
- HomeViewStates
- name: Extensions
children:
- Double
- UIColor
- View
- name: Functions
children:
- haptic_one_click()
- versionAndBuildNumber()
- name: structures
children:
- ForEachWithIndex
output: ./docs
clean: true
author: UCLA CS130 Team 8
module: Dots
module_version: 1.0.1
title: Dots - The Bill Splitter
source_directory: ./Dots
copyright: © 2021 Dots - The Bill Splitter
readme: README.md
min_acl: internal
github_url: https://github.com/cs130-w21/dots-ios
theme: apple
skip_undocumented: true
hide_documentation_coverage: true
#
#
#OUTPUT
#
# Config file: output
# Command line: -o, --output FOLDER
#
# Folder to output the HTML docs to
# Default: docs
#
#CLEAN
#
# Config file: clean
# Command line: -c, --[no-]clean
#
# Delete contents of output directory before running.
# WARNING: If --output is set to ~/Desktop, this will delete the ~/Desktop directory.
#
#OBJC MODE
#
# Config file: objc
# Command line: --[no-]objc
#
# Generate docs for Objective-C.
#
#UMBRELLA HEADER
#
# Config file: umbrella_header
# Command line: --umbrella-header PATH
#
# Umbrella header for your Objective-C framework.
#
#FRAMEWORK ROOT
#
# Config file: framework_root
# Command line: --framework-root PATH
#
# The root path to your Objective-C framework.
#
#SDK
#
# Config file: sdk
# Command line: --sdk [iphone|watch|appletv][os|simulator]|macosx
#
# The SDK for which your code should be built.
# Default: macosx
#
#HIDE DECLARATIONS
#
# Config file: hide_declarations
# Command line: --hide-declarations [objc|swift]
#
# Hide declarations in the specified language. Given that generating Swift docs only generates Swift declarations, this is useful for hiding a specific interface for either Objective-C or mixed Objective-C and Swift projects.
#
#KEEP PROPERTY ATTRIBUTES
#
# Config file: keep_property_attributes
# Command line: --[no-]keep-property-attributes
#
# Include the default Objective-C property attributes.
#
#CONFIG FILE
#
# Config file: config
# Command line: --config PATH
#
# Configuration file (.yaml or .json)
# Default: .jazzy.yaml in source directory or ancestor
#
#BUILD TOOL ARGUMENTS
#
# Config file: build_tool_arguments
# Command line: -b, --build-tool-arguments arg1,arg2,…argN
#
# Arguments to forward to xcodebuild, swift build, or sourcekitten.
# Default: []
#
#XCODEBUILD ARGUMENTS
#
# Config file: xcodebuild_arguments
# Command line: -x, --xcodebuild-arguments arg1,arg2,…argN
#
# Back-compatibility alias for build_tool_arguments.
#
#SOURCEKITTEN SOURCEFILE
#
# Config file: sourcekitten_sourcefile
# Command line: -s, --sourcekitten-sourcefile filepath1,…filepathN
#
# File(s) generated from sourcekitten output to parse
#
#SOURCE DIRECTORY
#
# Config file: source_directory
# Command line: --source-directory DIRPATH
#
# The directory that contains the source to be documented
# Default: /Users/jackzhao/Documents/UCLA/W21/Team-8-App/Dots
#
#EXCLUDED FILES
#
# Config file: exclude
# Command line: -e, --exclude filepath1,filepath2,…filepathN
#
# Source file pathnames to be excluded from documentation. Supports wildcards.
# Default: []
#
#INCLUDED FILES
#
# Config file: include
# Command line: -i, --include filepath1,filepath2,…filepathN
#
# Source file pathnames to be included in documentation. Supports wildcards.
# Default: []
#
#SWIFT VERSION
#
# Config file: swift_version
# Command line: --swift-version VERSION
#
#
#SWIFT BUILD TOOL
#
# Config file: swift_build_tool
# Command line: --swift-build-tool spm | xcodebuild | symbolgraph
#
# Control whether Jazzy uses Swift Package Manager, xcodebuild, or swift-symbolgraph to build the module to be documented. By default it uses xcodebuild if there is a .xcodeproj file in the source directory.
#
#AUTHOR NAME
#
# Config file: author
# Command line: -a, --author AUTHOR_NAME
#
# Name of author to attribute in docs (e.g. Realm)
#
#AUTHOR URL
#
# Config file: author_url
# Command line: -u, --author_url URL
#
# Author URL of this project (e.g. https://realm.io)
#
#MODULE NAME
#
# Config file: module
# Command line: -m, --module MODULE_NAME
#
# Name of module being documented. (e.g. RealmSwift)
#
#VERSION
#
# Config file: module_version
# Command line: --module-version VERSION
#
# Version string to use as part of the the default docs title and inside the docset.
# Default: 1.0
#
#TITLE
#
# Config file: title
# Command line: --title TITLE
#
# Title to display at the top of each page, overriding the default generated from module name and version.
#
#COPYRIGHT
#
# Config file: copyright
# Command line: --copyright COPYRIGHT_MARKDOWN
#
# copyright markdown rendered at the bottom of the docs pages
#
#README PATH
#
# Config file: readme
# Command line: --readme FILEPATH
#
# The path to a markdown README file
#
#DOCUMENTATION GLOB
#
# Config file: documentation
# Command line: --documentation GLOB
#
# Glob that matches available documentation
#
#ABSTRACT GLOB
#
# Config file: abstract
# Command line: --abstract GLOB
#
# Glob that matches available abstracts for categories
#
#PODSPEC
#
# Config file: podspec
# Command line: --podspec FILEPATH
#
# A CocoaPods Podspec that describes the Swift library to document
#
#POD SOURCES
#
# Config file: pod_sources
# Command line: --pod-sources url1,url2,…urlN
#
# A list of sources to find pod dependencies. Used only with --podspec when the podspec contains references to privately hosted pods. You must include the default pod source if public pods are also used.
# Default: []
#
#DOCSET ICON
#
# Config file: docset_icon
# Command line: --docset-icon FILEPATH
#
#
#DOCSET PATH
#
# Config file: docset_path
# Command line: --docset-path DIRPATH
#
# The relative path for the generated docset
#
#ROOT URL
#
# Config file: root_url
# Command line: -r, --root-url URL
#
# Absolute URL root where these docs will be stored
#
#DASH URL
#
# Config file: dash_url
# Command line: -d, --dash_url URL
#
# Location of the dash XML feed e.g. https://realm.io/docsets/realm.xml)
#
#GITHUB URL
#
# Config file: github_url
# Command line: -g, --github_url URL
#
# GitHub URL of this project (e.g. https://github.com/realm/realm-cocoa)
#
#GITHUB FILE PREFIX
#
# Config file: github_file_prefix
# Command line: --github-file-prefix PREFIX
#
# GitHub URL file prefix of this project (e.g. https://github.com/realm/realm-cocoa/tree/v0.87.1)
#
#DOCSET PLAYGROUND URL
#
# Config file: docset_playground_url
# Command line: --docset-playground-url URL
#
# URL of an interactive playground to demonstrate the framework, linked to from the docset.
#
#DISABLE SEARCH
#
# Config file: disable_search
# Command line: --disable-search
#
# Avoid generating a search index. Search is available in some themes.
#
#SKIP DOCUMENTATION
#
# Config file: skip_documentation
# Command line: --skip-documentation
#
# Will skip the documentation generation phase.
#
#MIN ACL
#
# Config file: min_acl
# Command line: --min-acl [private | fileprivate | internal | public | open]
#
# minimum access control level to document
# Default: public
#
#SKIP UNDOCUMENTED
#
# Config file: skip_undocumented
# Command line: --[no-]skip-undocumented
#
# Don't document declarations that have no documentation comments.
#
#HIDE DOCUMENTATION COVERAGE
#
# Config file: hide_documentation_coverage
# Command line: --[no-]hide-documentation-coverage
#
# Hide "(X% documented)" from the generated documents
#
#CUSTOM CATEGORIES
#
# Config file: custom_categories
#
# Custom navigation categories to replace the standard “Classes, Protocols, etc.”
# Types not explicitly named in a custom category appear in generic groups at the end.
# Example: https://git.io/v4Bcp
# Default: []
#
#CUSTOM CATEGORIES UNLISTED PREFIX
#
# Config file: custom_categories_unlisted_prefix
#
# Prefix for navigation section names that aren't explicitly listed in `custom_categories`.
# Default: Other
#
#HIDE UNLISTED DOCUMENTATION
#
# Config file: hide_unlisted_documentation
# Command line: --[no-]hide-unlisted-documentation
#
# Don't include documentation in the sidebar from the `documentation` config value that aren't explicitly listed in `custom_categories`.
#
#CUSTOM HEAD
#
# Config file: head
# Command line: --head HTML
#
# Custom HTML to inject into <head></head>.
#
#THEME DIRECTORY
#
# Config file: theme
# Command line: --theme [apple | fullwidth | jony | DIRPATH]
#
# Which theme to use. Specify either 'apple' (default), one of the other built-in theme names, or the path to your mustache templates and other assets for a custom theme.
# Default: apple
#
#USE SAFE FILENAMES
#
# Config file: use_safe_filenames
# Command line: --use-safe-filenames
#
# Replace unsafe characters in filenames with an encoded representation. This will reduce human readability of some URLs, but may be necessary for projects that expose filename-unfriendly functions such as /(_:_:)
#
#TEMPLATE DIRECTORY
#
# Config file: template_directory
# Command line: -t, --template-directory DIRPATH
#
# DEPRECATED: Use --theme instead.
#
#ASSETS DIRECTORY
#
# Config file: assets_directory
# Command line: --assets-directory DIRPATH
#
# DEPRECATED: Use --theme instead.
#
#UNDOCUMENTED TEXT
#
# Config file: undocumented_text
# Command line: --undocumented-text UNDOCUMENTED_TEXT
#
# Default text for undocumented symbols. The default is "Undocumented", put "" if no text is required
# Default: Undocumented
#
#SEPARATE GLOBAL DECLARATIONS
#
# Config file: separate_global_declarations
# Command line: --[no-]separate-global-declarations
#
# Create separate pages for all global declarations (classes, structures, enums etc.) even if they don't have children.