wiki

[SplinterGU]

Estariamos necesitando ayuda para completar la wiki, la verdad que no podemos esperar que Sandman complete todos los temas, y yo estoy dedicado al motor...

Quien se anima a colaborar? yo diria de arrancar con el mod_joys, que ya esta documentado en los fuentes... solo hay que copiar texto y agregar nombre de alguna que otra funcion alias...

aca dejo el link...

http://bennugd.svn.sourceforge.net/viewvc/bennugd/modules/mod_joy/mod_joy.c?revision=36&view=markup

Desde ya, muchisimas gracias.

[Drumpi]

Despues del mes que me voy fuera, si quieres (y no ha cambiado mucho la cosa desde la 093preview9, porque si no, tendría que reinvestigarlo todo) me pongo con las funciones de ficheros, que son con las que mejor me defiendo

[SplinterGU]

las funciones de ficheros, hay nuevas, y ya tengo nuevas para subir.

Yo pido de ir documentando lo que ya esta en el codigo, pero bennu, no fenix...

[Drumpi]

[ironic mode] Pensaba que Bennu era la sucesión directa de Fenix y no había que cambiar casi código para que funcione de una a otra [/ironic mode]

De todas formas, haré algunas pruebas e iré documentando lo que vaya viendo.

[SplinterGU]

el codigo fuente tiene mucha documentacion, se puede empezar por documentar en el wiki, aquellas funciones que ya estan documentadas en el codigo... la idea es darle el formato wiki y completar si hace falta.

desde ya, muchisimas gracias.

[osk]

En Agosto yo podré hacer algo.

[l1nk3rn3l]

dame un listado de funciones y las pasare este fin de semana..

[SplinterGU]

empecemos por:

mod_joy
mod_cd
mod_dir

en todos estos los fuentes estan documentadas las funciones de cara al usuario (las que escribimos en nuestros prgs)... luego ire poniendo mas...

[l1nk3rn3l]

mod_cd y mod_dir ya estan documentadas ,
asi que no fui yo,

intente documentar mod_joy pero no me aparece nada ,
asi si alguien lo puede subir:

mod_joy
------------------------------
INT JOY_AXES()
Returns the selected joystick total axes

INT JOY_AXES(INTEGER joy)
Returns the selected joystick total axes

INT JOY_NUMAXES()
Returns the selected joystick total axes


INT JOY_NUMAXES(INTEGER joy)
Returns the selected joystick total axes


INT JOY_GETAXIS(INTEGER axis)
Returns the selected joystick state for the given axis


INT JOY_GETAXIS(INTEGER joy, INTEGER axis)
Returns the selected joystick state for the given axis


INT JOY_BUTTONS()
Returns the selected joystick total buttons


INT JOY_BUTTONS(INTEGER joy)
Returns the selected joystick total buttons


STRING JOY_NAME(INTEGER joy)
 Returns the name for a given joystick present in the system


INT JOY_NUMBUTTONS()
Returns the selected joystick total buttons


INT JOY_NUMBUTTONS(INTEGER joy)
Returns the selected joystick total buttons

INT JOY_NUMBER()
Returns the number of joysticks present in the system

INT JOY_NUMJOYSTICKS()
Returns the number of joysticks present in the system

INT JOY_SELECT(INTEGER joy)
Returns the selected joystick number


INT JOY_GETBUTTON(INTEGER button)
Returns the selected joystick state for the given button

INT JOY_GETBUTTON(INTEGER joy, INTEGER button)
Returns the selected joystick state for the given button

INT JOY_GETPOSITION(INTEGER axis)
Returns the selected joystick state for the given axis

INT JOY_GETPOSITION(INTEGER joy, INTEGER axis)
Returns the selected joystick state for the given axis

INT JOY_NUMHATS()
Returns the total number of POV hats of the current selected joystick

INT JOY_NUMHATS(INTEGER joy)
Returns the total number of POV hats of the current selected joystick

INT JOY_NUMBALLS()
Returns the total number of balls of the current selected joystick

INT JOY_NUMBALLS(INTEGER joy)
Returns the total number of balls of the current selected joystick

INT JOY_GETHAT(INTEGER hat)
Returns the state of the specfied hat on the current selected joystick

INT JOY_GETHAT(INTEGER joy, INTEGER hat)
Returns the state of the specfied hat on the current selected joystick


INT JOY_GETBALL(INTEGER ball, POINTER dx, POINTER dy)
Returns the state of the specfied ball on the current selected joystick

INT JOY_GETBALL(INTEGER joy, INTEGER ball, POINTER dx, POINTER dy)

Returns the state of the specfied ball on the current selected joystick


/* Compatibility */


INT NUMBER_JOY()
Returns the number of joysticks present in the system


INT SELECT_JOY(INTEGER joy)
Returns the selected joystick number

INT GET_JOY_BUTTON(INTEGER button)
Returns the selected joystick state for the given button

INT GET_JOY_BUTTON(INTEGER joy, INTEGER button)
Returns the selected joystick state for the given button

INT GET_JOY_POSITION(INTEGER axis)
Returns the selected joystick state for the given axis

INT GET_JOY_POSITION(INTEGER joy, INTEGER axis)
Returns the selected joystick state for the given axis

[DCelso]

SplinterGU, parece que usas el formato de comentarios necesarios para que doxygen pueda extraerlos del código fuente y crear toda la documentación. ¿Estoy en lo cierto? o es simple coincidencia.

[DCelso]

linkerner, me ha llevado un rato introducir una función e
n la wiki, no es dificil pero es atareado. No tienes que editar la página mod_joy sino hacer una página para cada función, ese creo que fué tu problema.
A ver te explico los pasos a seguir.
1.- Pones en tu navegador favorito la dirección de la función a crear, por ejemplo:
http://wiki.bennugd.org/index.php?title=Joy_numaxes
2.- En esa página, pinchas en la pestaña que pone create.
3.- Insertas los datos de la función siguiendo esta plantilla:

Código: [Seleccionar]

[[Category:functions]]
[[Category:Joystick]]
[[Category:Mod_joy]]

==Definition==
'''INT''' joy_numaxes ( )

Returns the selected joystick total axes.

== Returns ==
'''INT''' : The selected joystick total axes.

{{Moduledocbox
  | module = Mod_joy
}}
4.- Das click en el botón save page.

Y ya está, listo, ya se encadena en las demás páginas solita la función.

[DCelso]

Lo que no se aún es sobrecargar la pagina de una función (las funciones que tienen mismo nombre pero distinto numero de parámetros de entrada osea joy_axes por ejemplo )

He hecho una prueba con esa función, usando un <br>or<br> si alguien sabe como sería más correcto que lo diga.

Yo no tengo mucho tiempo así que no voy a poder meter más, a ver si linkernel u otro voluntario puede seguir los pasos que puse para el resto, gracias.

[SplinterGU]

coincidencia

[DCelso]

sobre?

[SplinterGU]

SplinterGU, parece que usas el formato de comentarios necesarios para que doxygen pueda extraerlos del código fuente y crear toda la documentación. ¿Estoy en lo cierto? o es simple coincidencia.

sobre esto...