como documentar un proyecto laravel

[aldo_rengo]

hola miren, pues, me dijeron para comentar un proyecto y yo no tengo la menor idea, si bien un programador, programa, hace funcionar un sitio, esto parece que es como una presentacion de como trabajo uno , asi que hay que hacerlo bien...creo

el proyecto que tengo para documentar esta en laravel, ustedes conocen un framework

tiene los controler, model , views,

entonces, toca documentar , los modelos ? las vistas ? los controladores,

?y ademas =

en public , los js ? los css?

miren asi es como tengo documentado en el controlador. no es nada mas que comentar que hace el metodo, se que esta mal, pero creo que esa descripcion puede quedar...

Código PHP:

      /* 
 
    METHOD INDEX() 
 
    $data['carrers'] = data "carrers_jobs" table is extracted, being just a fact, the first request. 
    $data['redirect'] = if the browser detects that enters the site from a mobile device, this variable is used to redirect to "mobile / careers" 
 
    */ 
 
    public function index() { 
         $data['carrers']  = Carrersjobs::allcarrers()->first(); 
         $data['redirect'] = "careers"; 
          
        return View::make('section.careers', $data); 
    }