Function extractHandlerDocs

server/comments.go:126–164

extractHandlerDocs extracts documentation for all methods of a handler

(handler interface{})

// extractHandlerDocs extracts documentation for all methods of a handler
func extractHandlerDocs(handler interface{}) map[string]map[string]string {
	metadata := make(map[string]map[string]string)

	typ := reflect.TypeOf(handler)
	if typ == nil {
		return metadata
	}

	// Get the receiver type for methods
	rcvrType := typ
	if rcvrType.Kind() == reflect.Ptr {
		rcvrType = rcvrType.Elem()
	}

	// Iterate through methods
	for i := 0; i < typ.NumMethod(); i++ {
		method := typ.Method(i)

		// Skip non-exported methods
		if method.PkgPath != "" {
			continue
		}

		// Extract documentation from source
		description, example := extractMethodDoc(method, rcvrType)

		if description != "" || example != "" {
			metadata[method.Name] = make(map[string]string)
			if description != "" {
				metadata[method.Name]["description"] = description
			}
			if example != "" {
				metadata[method.Name]["example"] = example
			}
		}
	}

	return metadata
}