# RD -\> RDoc conversion

**URL:** <https://www.ruby-forum.com/t/rd-rdoc-conversion/157231>\
**Category:** Ruby\
**Created:** [January 8, 2009, 6:26pm UTC](https://www.ruby-forum.com/t/rd-rdoc-conversion/157231 "2009-01-08T18:26:15Z")\
**Posts on this page:** 3\
**Page:** 1

<div class="post-metadata">

**Author:** ![Jakub\_PavlSSS\_k\_jn](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/j/85e7bf/32.png) [@Jakub\_PavlSSS\_k\_jn](https://www.ruby-forum.com/u/Jakub_PavlSSS_k_jn)\
**Post date:** [January 8, 2009, 6:26pm UTC](https://www.ruby-forum.com/t/rd-rdoc-conversion/157231/1 "2009-01-08T18:26:15Z")

</div>

Good evening (at least in central Europe),

does anybody know about a tool which converts RD documentation to RDoc?  
I mean inline documentation in source files.  
It doesn’t have to have any advanced features - converting  
“=begin =end comments” to “# comments” and stripping all “(()) markup”  
is everything I need.  
If nobody knows about anything, I’ll probably have to try to write this  
tool myself…

Thank you for any tip.

Jakub Pavlik

–  
“Configure complete, now type ‘make’ and PRAY.”

```
            (configure script of zsnes - www.zsnes.com)
```

---

<div class="post-metadata">

**Author:** ![Jakub\_PavlSSS\_k\_jn](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/j/85e7bf/32.png) [@Jakub\_PavlSSS\_k\_jn](https://www.ruby-forum.com/u/Jakub_PavlSSS_k_jn)\
**Post date:** [January 8, 2009, 8:26pm UTC](https://www.ruby-forum.com/t/rd-rdoc-conversion/157231/2 "2009-01-08T20:26:18Z")

</div>

On Jan 8, 2009, at 11:25 AM, Jakub Pavlík jn. wrote:

> It doesn’t have to have any advanced features - converting  
> “=begin =end comments” to “# comments” and stripping all “(()) markup”  
> is everything I need.  
> If nobody knows about anything, I’ll probably have to try to write  
> this tool myself…

If it helps, rdoc supports =begin/=end – you just need to add the  
work rdoc to the begin

=begin rdoc

```
 docs

```

=end

---

<div class="post-metadata">

**Author:** ![Jakub\_PavlSSS\_k\_jn](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/j/85e7bf/32.png) [@Jakub\_PavlSSS\_k\_jn](https://www.ruby-forum.com/u/Jakub_PavlSSS_k_jn)\
**Post date:** [January 8, 2009, 9:05pm UTC](https://www.ruby-forum.com/t/rd-rdoc-conversion/157231/3 "2009-01-08T21:05:42Z")

</div>

It doesn’t help me much - my old inline documentation makes use of  
some markup that (as I think) isn’t valid RDoc markup:  
— for method synopsis,  
various ((something)) tags etc.  
I need to strip these too.

Jakub Pavlik

> work rdoc to the begin
> 
> =begin rdoc
> 
> ```
> docs
> 
> ```
> 
> =end

–  
“Configure complete, now type ‘make’ and PRAY.”

```
            (configure script of zsnes - www.zsnes.com)
```