This repository has been archived by the owner on Nov 2, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 336
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Converted jazzy config file to use YAML over JSON * Updated the markdown documentation for better syntax * Other minor updates * Updated Jazzy yaml for proper documentation * Minor update
- Loading branch information
1 parent
9bf3268
commit fc2f12d
Showing
5 changed files
with
266 additions
and
277 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -34,4 +34,4 @@ Carthage/Build | |
.idea/ | ||
|
||
## Ignore Docs Folder | ||
.docs | ||
docs/ |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,106 @@ | ||
--- | ||
author: Facebook | ||
author_url: https://developers.facebook.com | ||
copyright: Copyright (c) 2016-present, Facebook, Inc. All rights reserved. | ||
clean: true | ||
github_url: https://github.com/facebook/facebook-sdk-swift | ||
github_file_prefix: https://github.com/facebook/facebook-sdk-swift/tree/0.3.1 | ||
hide_documentation_coverage: true | ||
module: FacebookCore | ||
module_version: 0.3.1 | ||
output: docs | ||
podspec: FacebookCore.podspec | ||
readme: README.md | ||
skip_undocumented: true | ||
theme: fullwidth | ||
source_directory: Sources | ||
use_safe_filenames: true | ||
|
||
custom_categories: | ||
- children: | ||
- AccessToken | ||
- UserProfile | ||
- UserProfilePictureView | ||
- ApplicationDelegate | ||
- SDKSettings | ||
- SDKLoggingBehavior | ||
- SDKVersion | ||
name: Common | ||
- children: | ||
- AppEvent | ||
- AppEventName | ||
- AppEventParameterName | ||
- AppEventsLogger | ||
- AppEventLoggable | ||
- AppEventParameterValueType | ||
name: App Events | ||
- children: | ||
- LoginManager | ||
- LoginButton | ||
- LoginButtonDelegate | ||
- LoginBehavior | ||
- LoginDefaultAudience | ||
- LoginResult | ||
name: Facebook Login | ||
- children: | ||
- Permission | ||
- ReadPermission | ||
- PublishPermission | ||
name: Facebook Permissions | ||
- children: | ||
- GraphRequest | ||
- GraphRequestProtocol | ||
- GraphRequestResult | ||
- GraphRequestHTTPMethod | ||
- GraphResponse | ||
- GraphResponseProtocol | ||
- GraphRequestConnection | ||
- GraphRequestDataAttachment | ||
name: Graph API | ||
- children: | ||
- ShareButton | ||
- SendButton | ||
- LikeButton | ||
- LikeControl | ||
- LikableObject | ||
name: Sharing Buttons | ||
- children: | ||
- ShareDialog | ||
- ShareDialogMode | ||
- MessageDialog | ||
- ContentSharingDialogProtocol | ||
name: Sharing Dialogs | ||
- children: | ||
- LinkShareContent | ||
- Photo | ||
- PhotoShareContent | ||
- Video | ||
- VideoShareContent | ||
- Hashtag | ||
- ContentProtocol | ||
- ContentSharingResultProtocol | ||
- PostSharingResult | ||
name: Shareable Content | ||
- children: | ||
- OpenGraphObject | ||
- OpenGraphAction | ||
- OpenGraphShareContent | ||
- OpenGraphPropertyName | ||
- OpenGraphPropertyValue | ||
- OpenGraphPropertyContaining | ||
name: Share Custom Open Graph Stories | ||
- children: | ||
- GraphSharer | ||
- ShareError | ||
- ContentSharerResult | ||
- ContentSharingProtocol | ||
name: Sharing via Graph API | ||
- children: | ||
- AppInvite | ||
name: App Invites | ||
- children: | ||
- GameRequest | ||
name: Game Requests | ||
- children: | ||
- "==(_:_:)" | ||
name: Equality Helpers |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,36 +1,43 @@ | ||
# Contributing to Facebook Swift SDK | ||
|
||
We want to make contributing to this project as easy and transparent as possible. | ||
|
||
## Code of Conduct | ||
|
||
The code of conduct is described in [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md). | ||
|
||
## Pull Requests | ||
|
||
We actively welcome your pull requests. | ||
|
||
1. Fork the repo and create your branch from `master`. | ||
1. Fork the repo and create your branch from `master`. | ||
2. If you've added code that should be tested, add tests. | ||
3. If you've changed APIs, update the documentation. | ||
4. Ensure the test suite passes. | ||
5. Make sure your code lints. | ||
3. If you've changed APIs, update the documentation. | ||
4. Ensure the test suite passes. | ||
5. Make sure your code lints. | ||
6. If you haven't already, complete the Contributor License Agreement ("CLA"). | ||
|
||
## Contributor License Agreement ("CLA") | ||
|
||
In order to accept your pull request, we need you to submit a CLA. You only need | ||
to do this once to work on any of Facebook's open source projects. | ||
|
||
Complete your CLA here: <https://developers.facebook.com/opensource/cla> | ||
Complete your CLA here: [developers.facebook.com/opensource/cla](https://developers.facebook.com/opensource/cla) | ||
|
||
## Issues | ||
|
||
## Issues | ||
We use GitHub issues to track public bugs. Please ensure your description is | ||
clear and has sufficient instructions to be able to reproduce the issue. | ||
|
||
Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe | ||
Facebook has a [bounty program](https://www.facebook.com/whitehat) for the safe | ||
disclosure of security bugs. In those cases, please go through the process | ||
outlined on that page and do not file a public issue. | ||
|
||
## Coding Style | ||
* Most importantly, match the existing code style as much as possible. | ||
* Try to keep lines under 140 characters, if possible. | ||
## Coding Style | ||
|
||
- Most importantly, match the existing code style as much as possible. | ||
- Try to keep lines under 140 characters, if possible. | ||
|
||
## License | ||
|
||
See the [`LICENSE`](https://github.com/facebook/facebook-sdk-swift/blob/master/LICENSE) file. |
Oops, something went wrong.