Project

flagdoc

0.0
No commit activity in last 3 years
No release in over 3 years
Flagdoc is an alternative to the rake notes and inspired by the Yardoc syntax
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.16
~> 0.11
~> 10.0
~> 3.0
~> 0.16
 Project Readme

Flagdoc



Flagdoc is an alternative to the rake notes and inspired by the Yardoc syntax. Now, you can add customs flags with priority level !

Installation

gem install flagdoc

Usage

flagdoc

Example

./example/file.rb

# @flag [OLD, HIGH] being removed, prefere bar method
def foo
  # Do something...
end

# @flag [NEW] replacing foo method
def bar
  # Do something...
end

# @flag [TODO, LOW] must be renamed to baz
def bazz
  # Do something...
end

Will return something like that:

Terminal STDOUT

Levels:

  • LOW
  • NORMAL
  • HIGH