wordpress

Documentation

Index

• Constants
• type WordPressSource
  • func New() *WordPressSource
  • func (w *WordPressSource) DetectWrapper(method *source.Method) (bool, string, string)
  • func (w *WordPressSource) DiscoverEntities(ctx context.Context, fetch source.FetchFunc) ([]string, error)
  • func (w *WordPressSource) ID() string
  • func (w *WordPressSource) Meta() source.LibraryMeta
  • func (w *WordPressSource) ParseEntity(_ context.Context, url string, body []byte) (*source.Entity, []string, error)
  • func (w *WordPressSource) ParseMethod(_ context.Context, url string, body []byte) (*source.Method, error)
  • func (w *WordPressSource) ParseSourceCode(body []byte) (string, error)
  • func (w *WordPressSource) ResolveWrapperURL(targetName, targetKind, entitySlug string) string

Constants

const (
	BaseURL   = "https://developer.wordpress.org"
	LibraryID = "/wordpress/classes"
)

Types

type WordPressSource

type WordPressSource struct{}

func New

func New() *WordPressSource

func (*WordPressSource) DetectWrapper

func (w *WordPressSource) DetectWrapper(method *source.Method) (bool, string, string)

DetectWrapper analyzes a method's source code to determine if it's a wrapper. Returns (isWrapper, targetName, targetKind).

func (*WordPressSource) DiscoverEntities

func (w *WordPressSource) DiscoverEntities(ctx context.Context, fetch source.FetchFunc) ([]string, error)

func (*WordPressSource) ID

func (w *WordPressSource) ID() string

func (*WordPressSource) Meta

func (w *WordPressSource) Meta() source.LibraryMeta

func (*WordPressSource) ParseEntity

func (w *WordPressSource) ParseEntity(_ context.Context, url string, body []byte) (*source.Entity, []string, error)

func (*WordPressSource) ParseMethod

func (w *WordPressSource) ParseMethod(_ context.Context, url string, body []byte) (*source.Method, error)

func (*WordPressSource) ParseSourceCode

func (w *WordPressSource) ParseSourceCode(body []byte) (string, error)

ParseSourceCode extracts just the source code from a page.

func (*WordPressSource) ResolveWrapperURL

func (w *WordPressSource) ResolveWrapperURL(targetName, targetKind, entitySlug string) string

ResolveWrapperURL constructs the URL to fetch the wrapped method's documentation.