Skip to content

Commit

Permalink
Merge pull request #2 from woocommerce/phpdoc
Browse files Browse the repository at this point in the history
Phpdoc
  • Loading branch information
claudiosanches authored Aug 4, 2020
2 parents 1f33fda + 71f17d1 commit 2375803
Show file tree
Hide file tree
Showing 76 changed files with 6,121 additions and 4,704 deletions.
2 changes: 1 addition & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ root = true

[*]
indent_style = space
indent_size = 2
indent_size = 4
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
Expand Down
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
*.zip
build/
source/
woocommerce/
vendor/
!data/templates/woocommerce/
12 changes: 10 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,17 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.1.0] - 2020-08-03
### Added
- PHPDoc 3.0 RC support.
- New template
### Remove
- APIGen support.

## [0.0.1] - 2019-06-25
### Added
- Initial version.

[Unreleased]: https://github.com/woocommerce/woocommerce-api-docs/compare/0.0.1...HEAD
[0.0.1]: https://github.com/woocommerce/woocommerce-api-docs/compare/749f431...0.0.1
[Unreleased]: https://github.com/woocommerce/code-reference-generator/compare/0.1.0...HEAD
[0.1.0]: https://github.com/woocommerce/code-reference-generator/compare/0.0.1...0.1.0
[0.0.1]: https://github.com/woocommerce/code-reference-generator/compare/749f431...0.0.1
27 changes: 12 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,29 @@
# WooCommerce Class API Docs
# WooCommerce Code Reference Generator

Generate WooCommerce [Class API Docs](https://docs.woocommerce.com/wc-apidocs/index.html).
Generate [WooCommerce Code Reference](https://docs.woocommerce.com/wc-apidocs/index.html).

## Install

```bash
git clone https://github.com/woocommerce/woocommerce-api-docs.git
git clone https://github.com/woocommerce/code-reference-generator.git
```

## Usage

```bash
cd woocommerce-api-docs
./generate.sh -w <woocommerce_version>
cd code-reference-generator
./generate.sh -s <woocommerce_version>
```

### Options

| Options | Description |
|-------------------------|-------------------------|
| `-h` or `--help` | Shows help message |
| `-v` or `--version` | Shows generator version |
| `-w` or `--woocommerce` | WooCommerce version |

## TODO

- Find an alternative to ApiGen or fork ApiGen to fix support for latest PHP versions.
| Options | Description |
|----------------------------|-----------------------------------------------------------------|
| `-h` or `--help` | Shows help message |
| `-v` or `--version` | Shows generator version |
| `-s` or `--source-version` | Version of the source code to release |
| `-r` or `--github-repo` | GitHub repo with username, default to "woocommerce/woocommerce" |

## Changelog

[See changelog for details](https://github.com/woocommerce/woocommerce-api-docs/blob/master/CHANGELOG.md)
[See changelog for details](https://github.com/woocommerce/code-reference-generator/blob/master/CHANGELOG.md)
22 changes: 0 additions & 22 deletions apigen.neon

This file was deleted.

228 changes: 0 additions & 228 deletions apigen/hook-docs.php

This file was deleted.

13 changes: 0 additions & 13 deletions apigen/theme-woocommerce/404.latte

This file was deleted.

Loading

0 comments on commit 2375803

Please sign in to comment.