croquiscom/crojsdoc

@example available?

ianhaggerty opened this issue · 0 comments

The docs say there is an example tag available. However my compiler keeps feeding me

Unknown tag : example in C:/_dev/feathers_mongodb/lib/mongodb.coffee

Here is my usage

  # @example
  #   # remove aggregate functionality for `todoService`
  #   mongodb = require 'oscar-mongodb'
  #   mongodb.connect ->
  #     todoService = mongodb 'todo'
  #     delete todoService.options.pipeline

The examples are parsed and included, however, I cannot give them a title, nor is the code indented as in the documentation (I use two spaces). My version is crojsdoc@0.8.12 and I am on windows 7.