search

burtlo / yard-cucumber

YARD extension that adds Cucumber Features, Tags, and Step Definitions
MIT License
128 stars 46 forks source link

Step Definitions support @param tags #44

Open burtlo opened 11 years ago

burtlo commented 11 years ago 
# @param [String] type these type: [php, java] are supported
# @param [String] place the place from [local, there, somewhere]
Given /I create the "[^"]+" app at "[^"]+"/
pending
end
oradyvan commented 9 years ago

Hi @burtlo, I wonder if params are supported for step definitions? As I am using yardoc on this code:

# Launches the application in iPhone simulator with the specified SDK version.
#
# @param sdk [Fixnum] SDK version to be used, for example: 7.0, 8.1, etc
#
Given(/^I launch the app using iOS (\d\.\d)$/) do |sdk|
     pending
end

I can see the description line "Launches the application in iPhone simulator with the specified SDK version." in generated HTML documentation but not the params description. Is this configurable in some way?

burtlo commented 9 years ago

Currently it does not support that functionality. I added the feature here as a place to capture the idea and possibly see if others were interested in it.

I wish I could say that I had time to add the feature. I'm very busy with work and a baby.

oradyvan commented 9 years ago

Oh, I got it, sorry. Well, I'll try figure this out by myself and if I'll be able to make up some code, I'll publish pull request for this feature.