finereport2001 / markdown-doclet

Automatically exported from code.google.com/p/markdown-doclet
Other
0 stars 0 forks source link

Issues with following javadoc when using <code> or <pre> #4

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago
/**
 * This is an annotation to automatically mount Wicket Webpage's at a given
 * url in the application.
 *
 * Unlike wicket-stuff annotations, all common coding strategies are 
supported
 * through a single annotation.
 *
 * To use the mounting annotation see the class {@link AtAnnotation}.
 *
 * Mount any typical URL using:
 *
 * @At(url="/my-url")
 * public class MyPage extends WebPage {
 *    ....
 * }
 * 
 * To specify parameters that should be encoded after the specified URL, 
and
 * the order they should appear:
 *
 * @At(url="/my-url", urlParameters={"param1","param2"})
 * public class MyPage extends WebPage {
 *    ....
 * }
 * 
 * ... would create urls like `/my-url/param1val/param2val?
param3=x&param4=y`
 *
 * If you are using "indexed" URL strategy, i.e. `/my-
url/Integer0paramval/Integer1paramval/etc..`,
 * you can enable this by specifying - `@At(url="/my-url", 
type=URLType.Indexed)`
 *
 * If you want to use "Hybrid" style URLs where page state is encoded in 
the URL,
 * then specify - `@At(url="/my-url", type=URLType.StateInURL)` or,
 * `@At(url="/my-url", type=URLType.IndexedStateInURL)` for Hybrid+Indexed.
 *
 * Generally though, it is not necessary (and simpler) not to bother with 
types.
 *
 * @version $Id: At.java 79 2010-02-18 06:14:04Z tibes80@gmail.com $
 * @author Richard Nichols
 */

Original issue reported on code.google.com by tibe...@gmail.com on 20 Feb 2010 at 11:27

GoogleCodeExporter commented 9 years ago
This is actually a Javadoc issue, not markdown.

@At is interpretted as a Javadoc tag and causes the parsing to break.

It might be worth considering adding a synonym for '@' to the syntax, such that 
you 
could do [[at]] and have it replaced by @ in the generated text, thereby 
bypassing 
Javadoc.

Original comment by tibe...@gmail.com on 20 Feb 2010 at 11:56

GoogleCodeExporter commented 9 years ago

Original comment by tibe...@gmail.com on 22 Apr 2010 at 7:41