Yii Framework Forum: Use markdown for inline documentation - Yii Framework Forum

Jump to content

Page 1 of 1
  • You cannot start a new topic
  • You cannot reply to this topic

Use markdown for inline documentation Instead of HTML

#1 User is offline   Mike 

  • Elite Member
  • PipPipPipPipPip
  • Yii
  • Group: Members
  • Posts: 3,017
  • Joined: 06-October 08
  • Location:Upper Palatinate

Posted 20 June 2012 - 09:40 AM

The current inline documentation often uses HTML markup, for example here:

https://github.com/y...Manager.php#L18

I wonder if it would not make more sense to use markdown for this kind of documentation. It's much easier to parse and also much more readable in raw format.

Thoughts?
1

#2 User is offline   qiang 

  • Yii Project Lead
  • Yii
  • Group: Yii Dev Team
  • Posts: 5,907
  • Joined: 04-October 08
  • Location:DC, USA

Posted 20 June 2012 - 09:45 AM

We're already doing this for 2.0 code (with some extension to markdown, such as using [[Component]] to represent {@link Component}.
2

#3 User is offline   Mike 

  • Elite Member
  • PipPipPipPipPip
  • Yii
  • Group: Members
  • Posts: 3,017
  • Joined: 06-October 08
  • Location:Upper Palatinate

Posted 20 June 2012 - 12:38 PM

Great :)
0

Share this topic:


Page 1 of 1
  • You cannot start a new topic
  • You cannot reply to this topic

1 User(s) are reading this topic
0 members, 1 guests, 0 anonymous users