Skip to content
This repository has been archived by the owner on Jan 23, 2022. It is now read-only.

feat(docs): add resource type #165

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

feat(docs): add resource type #165

wants to merge 5 commits into from

Conversation

landru29
Copy link

I have the need to document all my angularjs resources.
to do so :

/**

  • @ngdoc resource

  • @name MyModule.resource:MyResource

  • @module MyModule

  • @description

  • Hello world !
    */
    angular.module('MyModule').service('MyResource', function($resource) {
    'use strict';
    return $resource('hello/world/:action', { }, {

    /**
     * @ngdoc function
     * @name create
     * @methodOf MyModule.resource:MyResource
     * @restMethod POST
     * @description
     *
     * @return {object} Promise
     */
    create: {
        method: 'POST',
        isArray: false,
        params:{action:''}
    }
    

    });
    });

@m7r
Copy link
Owner

m7r commented Apr 24, 2016

Thats a nice idea. Could you write a usage guide for the wiki?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants