Permalink
Browse files

Merge pull request #1026 from greenhost/1025-replace-camelcase-option…

…-names

Replace camelcase option names
  • Loading branch information...
jankal committed Apr 23, 2018
2 parents 8141881 + e95957c commit 85290e8086f2f40e4d560de09ffd115466379dc2
@@ -12,7 +12,7 @@ Just look at [**ApiGen API**](https://apigen.github.io/ApiGen):
![ApiGen Preview](docs/preview.png)
## Your Help is Needed to Finish 5.x Release
## Your Help is Needed to Finish 5.x Release
:heart: We need your help to test new version of ApiGen.
@@ -78,10 +78,10 @@ the root of your project:
```yaml
parameters:
visibilityLevels: [public, protected] # array
annotationGroups: [todo, deprecated] # array
visibility_levels: [public, protected] # array
annotation_groups: [todo, deprecated] # array
title: "ApiGen Docs" # string
baseUrl: "http://apigen.org/api" # string
base_url: "http://apigen.org/api" # string
overwrite: false # bool
```
@@ -121,29 +121,29 @@ A website url.
```php
/**
* This is already mentioned on Wiki.
* @link https://en.wikipedia.org/wiki/United_we_stand,_divided_we_fall Click to see a cool quote
* @link https://en.wikipedia.org/wiki/United_we_stand,_divided_we_fall Click to see a cool quote
*/
```
**Generated**
```html
This is already mentioned on Wiki.
@link <a href="https://en.wikipedia.org/wiki/United_we_stand,_divided_we_fall">Click to see a cool quote</a>
@link <a href="https://en.wikipedia.org/wiki/United_we_stand,_divided_we_fall">Click to see a cool quote</a>
```
### `@internal`
### `@internal`
Associated element is internal, so ApiGen hides it.
## Themes
To enable a custom theme just provide `themeDirectory` configuration option in your `apigen.yml`:
To enable a custom theme just provide `theme_directory` configuration option in your `apigen.yml`:
```yaml
parameters:
themeDirectory: path/to/theme # path to theme's config file
theme_directory: path/to/theme # path to theme's config file
```
## Contributing
@@ -9,7 +9,7 @@
/**
* @var string
*/
public const NAME = 'annotationGroups';
public const NAME = 'annotation_groups';
public function getName(): string
{
@@ -9,7 +9,7 @@
/**
* @var string
*/
public const NAME = 'baseUrl';
public const NAME = 'base_url';
public function getName(): string
{
@@ -11,7 +11,7 @@
/**
* @var string
*/
public const NAME = 'themeDirectory';
public const NAME = 'theme_directory';
/**
* @var FileSystem
@@ -10,7 +10,7 @@
/**
* @var string
*/
public const NAME = 'visibilityLevels';
public const NAME = 'visibility_levels';
/**
* @var string

0 comments on commit 85290e8

Please sign in to comment.