Docs need to list valid SDL constants #27

Closed
kthakore opened this Issue Jul 26, 2011 · 17 comments

Comments

Projects
None yet
1 participant
@kthakore
Member

kthakore commented Jul 26, 2011

Having to manually search Constants.pm for valid constants is a pain, and probably the source of many "magic values".

Ideally, each method call should be documented with a list of valid constants. I realize that this is a task of near-epic proportions.

As a start, an exhaustive list should be shown (or referred to) in the SDL documentation.

@kthakore

This comment has been minimized.

Show comment
Hide comment
@kthakore

kthakore Jul 26, 2011

Member

Author: kthakore
Time: 1254817437
Field: keywords
Value: Pod

Member

kthakore commented Jul 26, 2011

Author: kthakore
Time: 1254817437
Field: keywords
Value: Pod

@ghost ghost assigned kthakore Jul 26, 2011

@kthakore

This comment has been minimized.

Show comment
Hide comment
@kthakore

kthakore Jul 26, 2011

Member

Author: kthakore
Time: 1254817437
Field: difficulty
Value: Easy

Member

kthakore commented Jul 26, 2011

Author: kthakore
Time: 1254817437
Field: difficulty
Value: Easy

@kthakore

This comment has been minimized.

Show comment
Hide comment
@kthakore

kthakore Jul 26, 2011

Member

Author: kthakore
Time: 1254817437
Field: type
Value: task

Member

kthakore commented Jul 26, 2011

Author: kthakore
Time: 1254817437
Field: type
Value: task

@kthakore

This comment has been minimized.

Show comment
Hide comment
@kthakore

kthakore Jul 26, 2011

Member

Author: kthakore
Time: 1254817437
Field: milestone
Value: Exit Legacy

Member

kthakore commented Jul 26, 2011

Author: kthakore
Time: 1254817437
Field: milestone
Value: Exit Legacy

@kthakore

This comment has been minimized.

Show comment
Hide comment
@kthakore

kthakore Jul 26, 2011

Member

Author: kthakore
Time: 1254817437
Field: comment
Value:

Member

kthakore commented Jul 26, 2011

Author: kthakore
Time: 1254817437
Field: comment
Value:

@kthakore

This comment has been minimized.

Show comment
Hide comment
@kthakore

kthakore Jul 26, 2011

Member

Author: garu
Time: 1254980591
Field: comment
Value: Just so people can help, the task ahead is:

  • open SDL/Constant.pm
  • create a pod for each Constant, describing it.
  • group constants in pod by their purpose (i.e. where each set should be used.
Member

kthakore commented Jul 26, 2011

Author: garu
Time: 1254980591
Field: comment
Value: Just so people can help, the task ahead is:

  • open SDL/Constant.pm
  • create a pod for each Constant, describing it.
  • group constants in pod by their purpose (i.e. where each set should be used.
@kthakore

This comment has been minimized.

Show comment
Hide comment
@kthakore

kthakore Jul 26, 2011

Member

Author: garu
Time: 1254982069
Field: blocking
Value: 25

Member

kthakore commented Jul 26, 2011

Author: garu
Time: 1254982069
Field: blocking
Value: 25

@kthakore

This comment has been minimized.

Show comment
Hide comment
@kthakore

kthakore Jul 26, 2011

Member

Author: kthakore
Time: 1257958743
Field: status
Value: assigned

Member

kthakore commented Jul 26, 2011

Author: kthakore
Time: 1257958743
Field: status
Value: assigned

@kthakore

This comment has been minimized.

Show comment
Hide comment
@kthakore

kthakore Jul 26, 2011

Member

Author: kthakore
Time: 1257958743
Field: owner
Value: selvaraj

Member

kthakore commented Jul 26, 2011

Author: kthakore
Time: 1257958743
Field: owner
Value: selvaraj

@kthakore

This comment has been minimized.

Show comment
Hide comment
@kthakore

kthakore Jul 26, 2011

Member

Author: kthakore
Time: 1257958743
Field: comment
Value:

Member

kthakore commented Jul 26, 2011

Author: kthakore
Time: 1257958743
Field: comment
Value:

@kthakore

This comment has been minimized.

Show comment
Hide comment
@kthakore

kthakore Jul 26, 2011

Member

Author: FROGGS
Time: 1269299546
Field: status
Value: accepted

Member

kthakore commented Jul 26, 2011

Author: FROGGS
Time: 1269299546
Field: status
Value: accepted

@kthakore

This comment has been minimized.

Show comment
Hide comment
@kthakore

kthakore Jul 26, 2011

Member

Author: FROGGS
Time: 1269299546
Field: owner
Value: FROGGS

Member

kthakore commented Jul 26, 2011

Author: FROGGS
Time: 1269299546
Field: owner
Value: FROGGS

@kthakore

This comment has been minimized.

Show comment
Hide comment
@kthakore

kthakore Jul 26, 2011

Member

Author: FROGGS
Time: 1269299546
Field: comment
Value: for Pango and TTF they are in their namespace. Other modules will follow.

Member

kthakore commented Jul 26, 2011

Author: FROGGS
Time: 1269299546
Field: comment
Value: for Pango and TTF they are in their namespace. Other modules will follow.

@kthakore

This comment has been minimized.

Show comment
Hide comment
@kthakore

kthakore Jul 26, 2011

Member

Author: FROGGS
Time: 1269299613
Field: comment
Value: Constants are documented in the pods in the CONSTANTS section (right above METHODS).

Member

kthakore commented Jul 26, 2011

Author: FROGGS
Time: 1269299613
Field: comment
Value: Constants are documented in the pods in the CONSTANTS section (right above METHODS).

@kthakore

This comment has been minimized.

Show comment
Hide comment
@kthakore

kthakore Jul 26, 2011

Member

Author: FROGGS
Time: 1269561235
Field: status
Value: closed

Member

kthakore commented Jul 26, 2011

Author: FROGGS
Time: 1269561235
Field: status
Value: closed

@kthakore

This comment has been minimized.

Show comment
Hide comment
@kthakore

kthakore Jul 26, 2011

Member

Author: FROGGS
Time: 1269561235
Field: resolution
Value: fixed

Member

kthakore commented Jul 26, 2011

Author: FROGGS
Time: 1269561235
Field: resolution
Value: fixed

@kthakore

This comment has been minimized.

Show comment
Hide comment
@kthakore

kthakore Jul 26, 2011

Member

Author: FROGGS
Time: 1269561235
Field: comment
Value: Done

Member

kthakore commented Jul 26, 2011

Author: FROGGS
Time: 1269561235
Field: comment
Value: Done

@kthakore kthakore closed this Jul 26, 2011

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