дмитрий кабак | 13 Aug 2012 22:16
Picon
Gravatar

GSoC 2012: Doxygen, Weekly Report (August 06-August 13)

Done:
  1. Fixed some bugs, made comment output nicer.
  2. Fixed tokenizer a bit, so now Doxygen command in text, like 'hello\b world' should work (issue 2).
  3. Added some docs, updated project-plan.
  4. Refactored some code, cleaned-up some old unused methods.
  5. Fixed Doxygen warning generation.
  6. Made Doxygen parsing switched off by-default, so that any code will never fail in case of bad comment placement.
Commits:
  1. http://swig.svn.sourceforge.net/viewvc/swig?view=revision&revision=13551
  2. http://swig.svn.sourceforge.net/viewvc/swig?view=revision&revision=13563
  3. http://swig.svn.sourceforge.net/viewvc/swig?view=revision&revision=13576
  4. http://swig.svn.sourceforge.net/viewvc/swig?view=revision&revision=13577
  5. http://swig.svn.sourceforge.net/viewvc/swig?view=revision&revision=13582
  6. http://swig.svn.sourceforge.net/viewvc/swig?view=revision&revision=13591
  7. http://swig.svn.sourceforge.net/viewvc/swig?view=revision&revision=13597
  8. http://swig.svn.sourceforge.net/viewvc/swig?view=revision&revision=13598
  9. http://swig.svn.sourceforge.net/viewvc/swig?view=revision&revision=13602
Next week:
  1. Clean up the code.
  2. Fix bugs and add more tests.
  3. Write more docs.
  4. Work on the remaining issues, except those are marked as 'after-gsoc'.
Open issues:
  1. Attaching comments to the vars and constants in python is unsupported right now. Maybe attach these docs to top-level package, or rewrite the _wrap.cxx generated code to supply this info inside the Python lib built by swig.
  2. Rewrite tokenizer, or find a way to store whitespace info in current design. Definitely after-gsoc part, because that will only affect the 'niceness' of generated comments. 
  3. Also as an after-gsoc plan, rewrite the current parsing code. Right now it uses bison grammar, and that's not a really good idea to parse comments with that (one of the problems is that any misplaced doxygen comment will generate syntax error, and that's not a desired behavior). I already have some code parts to assign comments by line-numbers. As David Beazley said, that was already implemented some time ago in swig, but it was before the main repository was moved to svn and I couldn't find that changes. So I wrote an implementation myself, it needs lots of fixes and not very stable right now, so I don't want to commit it before the end of GSoC as current version is still working and capable of lots of things.

--
Regards,
Dmitry Kabak

------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/

Gmane