Skip to content

Loading…

Docs need to list valid SDL constants #27

Closed
kthakore opened this Issue · 17 comments

1 participant

@kthakore
PerlGameDev member

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
PerlGameDev member

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

@kthakore kthakore was assigned
@kthakore
PerlGameDev member

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

@kthakore
PerlGameDev member

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

@kthakore
PerlGameDev member

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

@kthakore
PerlGameDev member

Author: kthakore
Time: 1254817437
Field: comment
Value:

@kthakore
PerlGameDev 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.

@kthakore
PerlGameDev member

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

@kthakore
PerlGameDev member

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

@kthakore
PerlGameDev member

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

@kthakore
PerlGameDev member

Author: kthakore
Time: 1257958743
Field: comment
Value:

@kthakore
PerlGameDev member

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

@kthakore
PerlGameDev member

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

@kthakore
PerlGameDev member

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

@kthakore
PerlGameDev member

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

@kthakore
PerlGameDev member

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

@kthakore
PerlGameDev member

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

@kthakore
PerlGameDev member

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

@kthakore kthakore closed this
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.