tomdoc.vim

Purpose

Tomdoc.vim is a syntax add-on for vim designed to parse TomDoc comments. Since TomDoc is designed to be read in the code, it makes sense that we would want these comments to be as enjoyable to read from the editor as possible. The only thing this project will ever do is try to make your TomDocs pretty, so that you get more enjoyment out of using them.

Get it

You can either just throw the plugin and syntax directories into your ~/.vim folder, or you could use something better like Vundle (highly recommended) or Pathogen (somewhat less highly recommended) to manage this package for you. It should be compatible with both.

Known issues

The filters aren't as selective as I would like. I'm not sure how best to address some of them, and it may just be that the syntax highlighting is forever buggy because comments are the realm of plain English... and we all know how much that sucks.

Contributions

If tomdoc.vim interests you and you think you might want to contribute, hit me up over Github. You can also just fork it and make some changes, but there's a better chance that your work won't be duplicated or rendered obsolete if you check in on the current development status first.

Contributors

• Kassio Borges, who took the time to re-write the plugin the way it should have been written in the first place.

Development Notes

To run the tests you'll need the following:

• A working version of Ruby
• A working version of vim with the clientserver feature enabled. This is typically enabled by default for all vim distributions - you can check this by running vim --version and looking for +clientserver in the output.

If you have bundler, all you need to do to install the required gems is run:

bundle install

If you don't have/don't want bundler, you can instead install all of the gems as described in the Gemfile.

To run all the tests:

rake test

License

Copyright (C) 2012 by Tommy Morgan

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.