Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nisrulz/javadoc-themer

[Javadoc Tool] Give your boooring javadocs a splash of colors!
https://github.com/nisrulz/javadoc-themer

color-scheme javadoc javadoc-themer

Last synced: about 2 months ago
JSON representation

[Javadoc Tool] Give your boooring javadocs a splash of colors!

Host: GitHub
URL: https://github.com/nisrulz/javadoc-themer
Owner: nisrulz
License: apache-2.0
Created: 2016-05-14T21:53:10.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2024-03-26T22:14:34.000Z (6 months ago)
Last Synced: 2024-07-27T18:51:24.012Z (about 2 months ago)
Topics: color-scheme, javadoc, javadoc-themer
Language: HTML
Homepage: https://nisrulz.com/javadoc-themer/
Size: 1.74 MB
Stars: 84
Watchers: 4
Forks: 7
Open Issues: 1
Metadata Files:
- Readme: Readme.md
- License: LICENSE.txt

Awesome Lists containing this project

README

        # Javadoc Themer

Give your boooring javadocs a splash of colors!

Goto [webapp](https://nisrulz.com/javadoc-themer/)

### Featured in

[![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-javadoc--themer-green.svg?style=true)](https://android-arsenal.com/details/1/4196) [![AndroidDev Digest](https://img.shields.io/badge/AndroidDev%20Digest-%2399-blue.svg)](https://www.androiddevdigest.com/digest-99/)

### Show some :heart:

[![GitHub stars](https://img.shields.io/github/stars/nisrulz/javadoc-themer.svg?style=social&label=Star)](https://github.com/nisrulz/javadoc-themer) [![GitHub forks](https://img.shields.io/github/forks/nisrulz/javadoc-themer.svg?style=social&label=Fork)](https://github.com/nisrulz/javadoc-themer/fork) [![GitHub watchers](https://img.shields.io/github/watchers/nisrulz/javadoc-themer.svg?style=social&label=Watch)](https://github.com/nisrulz/javadoc-themer) [![GitHub followers](https://img.shields.io/github/followers/nisrulz.svg?style=social&label=Follow)](https://github.com/nisrulz/javadoc-themer)

## Web app screenshot

![screenshot](img/javadocthemer.png)

## Output

![screenshotdiff](img/javadocdiff.png)

### *Command line arguments*

```bash

-encoding UTF-8 -docencoding utf-8 -charset utf-8 \

-stylesheetfile /javadoc_stylesheet.css 

```

If you want to use/include custom tags in your javadoc, use `-tag custom.:a:""` i.e

```bash

-tag custom.package:a:"Package" -tag custom.company:a:"Company"

```

hence your complete command line arguments becomes

```bash

-encoding UTF-8 -docencoding utf-8 -charset utf-8 \

-tag custom.package:a:"Package" -tag custom.company:a:"Company"  \

-stylesheetfile /javadoc_stylesheet.css

```

License

=======

    Copyright 2016 Nishant Srivastava

    Licensed under the Apache License, Version 2.0 (the "License");

    you may not use this file except in compliance with the License.

    You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software

    distributed under the License is distributed on an "AS IS" BASIS,

    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

    See the License for the specific language governing permissions and

    limitations under the License.