Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

Refactor code comments to make them compatible with default doxygen settings #67

Closed
fdelapena opened this Issue Jan 14, 2013 · 0 comments

Comments

Projects
None yet
1 participant
Owner

fdelapena commented Jan 14, 2013

Doxygen is not parsing well comments like this:

/////////////////////////////////////////////////////////////////////////////

Because at least /// triggers Doxygen.

RGSS does:

#==============================================================================
# ** Class_Name
#------------------------------------------------------------------------------
#  This class does something,
#  etc. Refer to "$class_name" for the instance of this class.
#==============================================================================

class Class_Name
  #--------------------------------------------------------------------------
  # * Public Instance Variables
  #--------------------------------------------------------------------------

We should go as we already made for Readers:

/*
 * License header
 */
// Non-doxygen comments
/** one line doxygen comments (for vars and enum members) */
/**
 * Multi-line doxygen comment
 *
 * @param foo bar
 * @param bar baz
 */

@ghost ghost assigned fdelapena Jan 14, 2013

@Ghabry Ghabry closed this in 2495ed4 Mar 19, 2013

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment