dc/d1c/comments_8h_source.html

#ifndef PRISM_COMMENTS_H

#define PRISM_COMMENTS_H


#include "prism/compiler/exported.h"

#include "prism/compiler/nodiscard.h"

#include "prism/compiler/nonnull.h"


#include "prism/ast.h"


#include <stddef.h>


typedef enum {

    PM_COMMENT_INLINE,

    PM_COMMENT_EMBDOC

} pm_comment_type_t;


typedef struct pm_comment_t pm_comment_t;


PRISM_EXPORTED_FUNCTION pm_location_t pm_comment_location(const pm_comment_t *comment) PRISM_NONNULL(1);


PRISM_EXPORTED_FUNCTION pm_comment_type_t pm_comment_type(const pm_comment_t *comment) PRISM_NONNULL(1);


#endif

pm_comment_location
PRISM_EXPORTED_FUNCTION pm_location_t pm_comment_location(const pm_comment_t *comment) PRISM_NONNULL(1)
Returns the location associated with the given comment.
Definition parser.c:158

pm_comment_type
PRISM_EXPORTED_FUNCTION pm_comment_type_t pm_comment_type(const pm_comment_t *comment) PRISM_NONNULL(1)
Returns the type associated with the given comment.
Definition parser.c:166

pm_comment_type_t
pm_comment_type_t
This is the type of a comment that we've found while parsing.
Definition comments.h:18

exported.h

PRISM_EXPORTED_FUNCTION
#define PRISM_EXPORTED_FUNCTION
By default, we compile with -fvisibility=hidden.
Definition exported.h:20

nodiscard.h

nonnull.h

PRISM_NONNULL
#define PRISM_NONNULL(...)
Mark the parameters of a function as non-null.
Definition nonnull.h:13

pm_comment_t
Definition comments.h:9

pm_location_t
This struct represents a slice in the source code, defined by an offset and a length.
Definition ast.h:554